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.
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
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 Scope Using POST
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 Scopes 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 All Object Scopes Using GET
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 Scope 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 Scope Using PUT
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