API v2: User Directory - Group Mapping - Adding to Roles 🆕

Data Structures

UserDirectoryGroupRoleModel

Attribute	Type	Required	Description
id	string		Read-only, protected, unique object identifier.
user_directory_group_id	string	yes	Immutable. Uniqueness is required in the combination of attribute user_directory_group_id with attribute role_id.
role_id	string	yes	Uniqueness is required in the combination of attribute role_id with attribute user_directory_group_id.
user_directory_id	string		Read-only. Expensive to use.
user_directory_name	string		Read-only. Expensive to use.
user_directory_type	string		Read-only. Expensive to use.
group_name	string		Read-only. Expensive to use.
user_directory_group_path	string		Read-only. Expensive to use.
user_directory_group_guid	string		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 UserDirectoryGroupRoleModel

Request

Method	GET
Path	/api/v2/objspec/user_directory_group_role

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

Get Roles Assigned via Group Mapping

Request

Method	GET
Path	/api/v2/user_directory_group/role

GET /api/v2/user_directory_group/role

Example Request

curl -s -k -X GET  \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk'  \
'https://10.0.214.98/api/v2/user_directory_group/role'

Response

{
    "result": "success",
    "user_directory_group_role": [
        {
            "user_directory_group_id": "5683542729741565953",
            "role_id": "5683542729741565964",
            "user_directory_id": "5683542729741565954",
            "user_directory_name": "active-directory-10.0.242.80 [domain: example.com]",
            "user_directory_type": "AD",
            "role_name": "Server Admin",
            "user_directory_group_path": "CN=Users,CN=Builtin,DC=example,DC=com",
            "user_directory_group_guid": "\\CC\\04\\58\\2C\\BB\\9B\\E5\\46\\A0\\B1\\D0\\E3\\02\\71\\BC\\0E",
            "created_at": "2025-06-02 04:02:29.911793-07",
            "modified_at": "2025-06-02 04:02:29.911793-07"
        }
    ]
}

Get Roles Assigned via a Specific Group Mapping

Request

Method	GET
Path	/api/v2/user_directory_group/<user_directory_group_id>/role

GET /api/v2/user_directory_group/<user_directory_group_id>/role

Example Request

curl -s -k -X GET  \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk'  \
'https://10.0.214.98/api/v2/user_directory_group/5683542729741565953/role'

Response

{
    "result": "success",
    "user_directory_group_role": [
        {
            "user_directory_group_id": "5683542729741565953",
            "role_id": "5683542729741565964",
            "user_directory_id": "5683542729741565954",
            "user_directory_name": "active-directory-10.0.242.80 [domain: example.com]",
            "user_directory_type": "AD",
            "role_name": "Server Admin",
            "user_directory_group_path": "CN=Users,CN=Builtin,DC=example,DC=com",
            "user_directory_group_guid": "\\CC\\04\\58\\2C\\BB\\9B\\E5\\46\\A0\\B1\\D0\\E3\\02\\71\\BC\\0E",
            "created_at": "2025-06-02 04:02:29.911793-07",
            "modified_at": "2025-06-02 04:02:29.911793-07"
        }
    ]
}

Get Assigned Role by Group Mapping ID and Role ID

Request

Method	GET
Path	/api/v2/user_directory_group/<user_directory_group_id>/role/<role_id>

GET /api/v2/user_directory_group/<user_directory_group_id>/role/<role_id>

Example Request

curl -s -k -X GET  \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk'  \
'https://10.0.214.98/api/v2/user_directory_group/5683542729741565953/role/5683542729741565964'

Response

{
    "result": "success",
    "user_directory_group_role": [
        {
            "user_directory_group_id": "5683542729741565953",
            "role_id": "5683542729741565964",
            "user_directory_id": "5683542729741565954",
            "user_directory_name": "active-directory-10.0.242.80 [domain: example.com]",
            "user_directory_type": "AD",
            "role_name": "Server Admin",
            "user_directory_group_path": "CN=Users,CN=Builtin,DC=example,DC=com",
            "user_directory_group_guid": "\\CC\\04\\58\\2C\\BB\\9B\\E5\\46\\A0\\B1\\D0\\E3\\02\\71\\BC\\0E",
            "created_at": "2025-06-02 04:02:29.911793-07",
            "modified_at": "2025-06-02 04:02:29.911793-07"
        }
    ]
}

Define Role Assigned via Group Mapping

Request

Method	POST
Path	/api/v2/user_directory_group/<user_directory_group_id>/role
Headers	Content-Type: Application/json
Body	UserDirectoryGroupRoleModel

POST /api/v2/user_directory_group/<user_directory_group_id>/role

Example Request

curl -s -k -X POST  \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk'  \
-H 'Content-Type: application/json'  \
https://10.31.96.188/api/v2/user_directory_group/5683542729741565954/role \
-d'{"role_id":"5683542729741565966"}'

Response

{
    "result": "success"
}

Delete Role Assigned via Group Mapping

Request

Method	DELETE
Path	/api/v2/user_directory_group/<user_directory_group_id>/role/<role_id>

DELETE /api/v2/user_directory_group/<user_directory_group_id>/role/<role_id>

Example Request

curl -s -k -X DELETE \
-H 'Authorization:proxycrypto' \
https://10.31.96.188/api/v2/user_directory_group/5683542729741565954/role/5683542729741565966

Response

{
    "result": "success"
}