Get Scope Using GET

Get Scope Using GET

Get the scope by its id

Request

URI

GET

https://{api_host}/api/auth/scopes/{scopeId}

COPY

Path Parameters

string

scopeId

Required

The scope id to retrieve

Authentication

This operation uses the following authentication methods.

CSPToken

Responses

200

The scope corresponding to the specified id

Returns scope-details of type(s) application/json

{
    "createdBy": "string",
    "creationTime": 0,
    "description": "string",
    "id": "string",
    "lastModifiedBy": "string",
    "lastModifiedTime": 0,
    "name": "string",
    "traversalSpecInstances": [
        {
            "adapterKind": "string",
            "includedAdapterKinds": [
                "string"
            ],
            "name": "string",
            "resourceKind": "string",
            "resourceSelection": [
                {
                    "resourceId": [
                        "string"
                    ],
                    "type": "string"
                }
            ],
            "selectAllResources": false
        }
    ]
}

string As uuid As uuid

createdBy

Optional

The user id who created the scope.

integer As int64 As int64

creationTime

Optional

Creation time of the scope

string

description

Optional

Description of the scope.

string As uuid As uuid

id

Required

Identifier of the scope in the system.

string As uuid As uuid

lastModifiedBy

Optional

The user id who last modified the scope.

integer As int64 As int64

lastModifiedTime

Optional

Last Modification time of the scope

string

name

Required

Name of the scope.

array of traversal-spec-instance

traversalSpecInstances

Optional

List of traversal spec instances.

On This Page

Request

Path Parameters

200 Response Body

Auth Operations

Add Role Privileges Using POST

Assign Role Permission To User Group Using PUT

Assign Role Permission To User Using PUT

Create Scope Using POST

Create User Group Using POST

Create User Role Using POST

Delete Scopes Using DELETE

Delete User Groups Using DELETE

Delete User Group Using DELETE

Delete User Role Using DELETE

Get All Object Scopes Using GET

Get Assigned Role Permissions For Current User Using GET

Get Assigned Role Permissions For User Group Using GET

Get Assigned Role Permissions For User Using GET

Get Auth Sources Using GET

Get Auth Source Types Using GET

Get Auth Source Type Using GET

Get Auth Source Using GET

Get Available Privilege Groups Using GET

Get Available Privileges Using GET

Get Current User Role Privileges Using GET

Get Current User Using GET

Get Role By Name Using GET

Get Role Privileges Using GET

Get Roles Using GET

Get Scope Using GET

Get Traversal Specs Using GET

Get User Groups Using GET

Get User Group Using GET

Get Users Using GET

Get User Using GET

Modify Scope Using PUT

Modify User Group Using PUT

Modify User Using PUT

Remove Role Privileges Using DELETE

Set Role Privileges Using PUT

Synchronize User Groups Using PUT

Unassigned Role Permission From User Group Using DELETE

Unassigned Role Permission From User Using DELETE

Update User Role Using PUT