Assign Traversal Spec To User

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}/suite-api/api/auth/users/{userId}/traversalspecs

COPY

Path Parameters

string

userId

Required

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

Request Body

The traversal specification to assign to the user

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

Required

Show optional properties

{
    "adapterKind": "string",
    "name": "string"
}

"No Custom Example is Available"

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.

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.

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.

array of object

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.

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.

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The traversal spec is assigned to the user successfully

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adapterKind:"string","name:"string"}' https://{api_host}/suite-api/api/auth/users/{userId}/traversalspecs

Deprecated

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Auth Operations