Get Scope

Get Scope

Get the scope by its id

Request
URI
GET
https://{api_host}/suite-api/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 
"{\n  \"id\" : \"57922ca1-1bea-46c5-80d8-9f112b8805b0\",\n  \"name\" : \"MS_SQL_Restricted_VMs\",\n  \"description\" : \"Allow only VMs having application MS SQL Server\",\n  \"createdBy\" : \"c62a722e-7e5f-4bd1-ac11-825255271b6f\",\n  \"creationTime\" : 1744473856999,\n  \"lastModifiedBy\" : \"db05a67e-39d7-4560-bc9d-5f0c3d9aeb51\",\n  \"lastModifiedTime\" : 1744473856999,\n  \"traversalSpecInstances\" : [ {\n    \"adapterKind\" : \"VMWARE\",\n    \"resourceKind\" : \"vSphere World\",\n    \"name\" : \"vSphere Hosts and Clusters\",\n    \"resourceSelection\" : [ {\n      \"type\" : \"SPECIFIC\",\n      \"resourceId\" : [ \"7f430ad1-9648-4419-9bc1-7cb0d2855f7c\" ]\n    } ],\n    \"selectAllResources\" : false\n  } ]\n}"
string As uuid As uuid
id
Required

Identifier of the scope in the system.

string
name
Required

Name of the scope.

string
description
Optional

Description of the scope.

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 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

array of object
traversalSpecInstances
Optional

List of traversal spec instances.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/auth/scopes/{scopeId}
On This Page
Auth Operations
GET
Get Users
PUT
Modify User
POST
Create User
DELETE
Delete Users
PUT
Assign Traversal Spec To User
Deprecated
GET
Get Assigned Role Permissions For User
PUT
Assign Role Permission To User
PUT
Change Password
GET
Get User Groups
PUT
Modify User Group
POST
Create User Group
DELETE
Delete User Groups
PUT
Assign Traversal Spec To User Group
Deprecated
GET
Get Assigned Role Permissions For User Group
PUT
Assign Role Permission To User Group
GET
Get Auth Sources
PUT
Update Auth Source
POST
Add Auth Source
PATCH
Patch Auth Source With Certificate Details
PUT
Synchronize User Groups
GET
Get All Object Scopes
PUT
Modify Scope
POST
Create Scope
DELETE
Delete Scopes
GET
Get Roles
PUT
Update User Role
POST
Create User Role
GET
Get Role Privileges
PUT
Set Role Privileges
POST
Add Role Privileges
DELETE
Remove Role Privileges
POST
Release Token
POST
Acquire Token
POST
Import Users
POST
Search Users For Auth Source
POST
Search User Groups For Auth Source
POST
Test Auth Source
PATCH
Patch Test Auth Source
GET
Get User
DELETE
Delete User
GET
Get User Group
DELETE
Delete User Group
GET
Get Traversal Specs
GET
Get Auth Source Types
GET
Get Auth Source Type
GET
Get Auth Source
DELETE
Delete Auth Source
GET
Get Scope
GET
Get Role By Name
DELETE
Delete User Role
GET
Get Available Privileges
GET
Get Available Privilege Groups
GET
Get Current User
GET
Get Current User Role Privileges
GET
Get Assigned Role Permissions For Current User
DELETE
Unassigned Role Permission From User
DELETE
Unassigned Role Permission From User Group