User Directory - Adding Group Mapping

Data Structures

UserDirectoryGroupModel

Attribute	Type	Required	Description
id	string		Read-only, unique object identifier.
group_path	string	yes	Uniqueness is required in the combination of attribute group_path with attributes group_guid, and user_directory_id.
group_guid	string	yes	Uniqueness is required in the combination of attribute group_guid with attributes group_path, and user_directory_id.
user_directory_id	string	yes	Uniqueness is required in the combination of attribute user_directory_id with attributes group_path, and group_guid.
user_directory_name	string		Read-only. Expensive to use.
user_directory_type	string		Read-only. Expensive to use.
groups	object-array		Read-only. Expensive to use.
roles	object-array		Read-only. Expensive to use.
external_authentications	object-array		Read-only. Expensive to use.
created_at	datetime		Read-only. Timestamp of creation.
modified_at	datetime		Read-only. Timestamp of modification.
removed	boolean		Read-only.

Retrieve Available Attributes of the UserDirectoryGroupModel

Request

Method	GET
Path	/api/v2/objspec/user_directory_group

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

Get Existing User Directory Groups Configuration

Request

Method	GET
Path	/api/v2/user_directory_group

GET /api/v2/user_directory_group

Example Request

curl -s -k -X GET  \
-H 'Authorization: <token>'  \
'https://10.0.214.98/api/v2/user_directory_group'

Response

{
    "result": "success",
    "user_directory_group": [
        {
            "id": "5683542729741565953",
            "group_path": "CN=Users,CN=Builtin,DC=example,DC=com",
            "group_guid": "\\CC\\04\\58\\2C\\BB\\9B\\E5\\46\\A0\\B1\\D0\\E3\\02\\71\\BC\\0E",
            "user_directory_id": "5683542729741565954",
            "user_directory_name": "active-directory-10.0.242.80 [domain: example.com]",
            "user_directory_type": "AD",
            "groups": [
                {
                    "id": "5683542729741565958",
                    "name": "Group_A",
                    "description": null
                }
            ],
            "roles": [
                {
                    "id": "5683542729741565964",
                    "name": "Server Admin",
                    "description": null
                }
            ],
            "created_at": "2025-06-02 04:02:29.893151-07",
            "modified_at": "2025-06-02 04:02:29.912421-07"
        }
    ]
}

Get Group Configuration by ID

Request

Method	GET
Path	/api/v2/user_directory_group/<id>

GET /api/v2/user_directory_group/<id>

Example Request

curl -s -k -X GET  \
-H 'Authorization:<token>'  \
'https://10.31.135.179/api/v2/user_directory_group/5683542729741565953'

Response

{
    "result": "success",
    "user_directory_group": [
        {
            "id": "5683542729741565953",
            "group_path": "CN=Users,CN=Builtin,DC=example,DC=com",
            "group_guid": "\\CC\\04\\58\\2C\\BB\\9B\\E5\\46\\A0\\B1\\D0\\E3\\02\\71\\BC\\0E",
            "user_directory_id": "5683542729741565954",
            "user_directory_name": "active-directory-10.0.242.80 [domain: example.com]",
            "user_directory_type": "AD",
            "groups": [
                {
                    "id": "5683542729741565958",
                    "name": "Group_A",
                    "description": null
                }
            ],
            "roles": [
                {
                    "id": "5683542729741565964",
                    "name": "Server Admin",
                    "description": null
                }
            ],
            "created_at": "2025-06-02 04:02:29.893151-07",
            "modified_at": "2025-06-02 04:02:29.912421-07"
        }
    ]
}

Define Group Configuration for Specific User Directory

Request

Method	POST
Path	/api/v2/user_directory_group
Headers	Content-Type: Application/json
Body	UserDirectoryGroupModel

POST /api/v2/user_directory_group

Example Request

curl -s -k -X POST  \
-H 'Authorization:<token>'  \
-H 'Content-Type: application/json'  \
https://10.31.96.188/api/v2/user_directory_group \
-d'{"group_path":"CN=Guests,CN=Builtin,DC=example,DC=com","group_guid":"2c5804cc-9bbb-46e5-a0b1-d0e30271bc0e","user_directory_id":"5683542729741565954"}'

Response

{
    "result": "success",
    "user_directory_group": {
        "id": "5683542729741565956"
    }
}

Modify Group Configuration for Specific User Directory

Request

Method	PATCH
Path	/api/v2/user_directory_group/<id>
Headers	Content-Type: Application/json
Body	UserDirectoryGroupModel

PATCH /api/v2/user_directory_group/<id>

Example Request

curl -s -k -X PATCH  \
-H 'Authorization:<token>'  \
-H 'Content-Type: application/json'  \
https://10.31.96.188/api/v2/user_directory_group/5683542729741565954 \
-d'{"group_path":"CN=Admins,CN=Builtin,DC=example,DC=com"}'

Response

{
    "result": "success"
}

Deleting Group from User Directory Configuration

Request

Method	DELETE
Path	/api/v2/user_directory_group/<id>

DELETE /api/v2/user_directory_group/<id>

Example Request

curl -s -k -X DELETE  \
-H 'Authorization:vg1ei6rgo58fsbobr7octp0w3afd9vsm'  \
https://10.31.135.179/api/v2/user_directory_group/5683542729741565954

Response

{
    "result": "success"
}