Assign Traversal Spec To User Group Using PUT

Assign Traversal Spec To User Group Using PUT

Traversal specifications assigned through this API will add the specified traversal specification to a role permission for the ReadOnly role. It will also update the user's existing role permissions with this traversal specification. This API is replaced by the assignRolePermissionToUser and unassignRolePermissionFromUser APIs which are PUT and DELETE operations respectively at the /auth/usergroups/{groupId}/permissions endpoint.Note: mixing current and deprecated APIs is not recommended and may result in undefined behavior.

Request
URI
PUT
https://{api_host}/api/auth/usergroups/{groupId}/traversalspecs
COPY
Path Parameters
string
groupId
Required

Identifier of the user group to which the traversal spec needs to be assigned


Request Body

The traversal specification to assign to the user group

traversal-spec-instance of type(s) application/json
Required

Show optional properties

{
    "adapterKind": "string",
    "name": "string"
}
{
    "adapterKind": "string",
    "includedAdapterKinds": [
        "string"
    ],
    "name": "string",
    "resourceKind": "string",
    "resourceSelection": [
        {
            "resourceId": [
                "string"
            ],
            "type": "string"
        }
    ],
    "selectAllResources": false
}
string
adapterKind
Required

The root Adapter kind of the Traversal Specification. Together with resourceKind and name these values uniquely identify the traversal specification used by this instance.

array of string
includedAdapterKinds
Optional

The adapter kinds that apply to this traversal specification instance. Only applicable for traversal specification templates with a filter type of ADAPTER_ASSOCIATION. If this is present, then all adapter instances of this kind are selected as part of the hierarchy.

string
name
Required

The name of the Traversal Specification. Together with adapterKind and resourceKind these values uniquely identify a traversal specification used by this instance.

string
resourceKind
Optional

The root Resource kind of the Traversal Specification. Together with adapterKind and name these values uniquely identify a traversal specification used by this instance.

resourceSelection
Optional

List of root resource id selections

boolean
selectAllResources
Optional

When flag is true system will ignore resource selections and include all resources in the tree defined by the traversal specification templat.

Authentication
This operation uses the following authentication methods.
Responses
200

The traversal spec is assigned to the user group successfully

Operation doesn't return any data structure

Deprecated
Auth Operations
POST
Acquire Token Using POST
POST
Add Auth Source Using POST
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
PUT
Assign Traversal Spec To User Group Using PUT
Deprecated
PUT
Assign Traversal Spec To User Using PUT
Deprecated
PUT
Change Password Using PUT
POST
Create User Group Using POST
POST
Create User Role Using POST
POST
Create User Using POST
DELETE
Delete Auth Source Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
DELETE
Delete Users Using DELETE
DELETE
Delete User Using DELETE
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
POST
Import Users Using POST
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
PATCH
Patch Auth Source With Certificate Details Using PATCH
PATCH
Patch Test Auth Source Using PATCH
POST
Release Token Using POST
DELETE
Remove Role Privileges Using DELETE
POST
Search User Groups For Auth Source Using POST
POST
Search Users For Auth Source Using POST
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
POST
Test Auth Source Using POST
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update Auth Source Using PUT
PUT
Update User Role Using PUT