ScopesResource


Create a scope


POST https://example.com/api/admin/scopes

Roles : [ROLE_USERS_MANAGE_SCOPES]

Content-Type : scope Accept : scope

Error Codes

  • SCOPE-1 - The requested scope does not exist
  • SCOPE-21 - Only users with an unlimited scope are allowed to make a scope unlimited

Example

List scopes


Retrieves scopes available to associate with roles.

GET https://example.com/api/admin/scopes

Roles : [ROLE_USERS_VIEW_PRIVILEGES, ROLE_USERS_MANAGE_SCOPES, ROLE_USERS_MANAGE_USERS, ROLE_APPLIB_ALLOW_MODIFY, ROLE_MANAGE_VAPP_SPEC]

Parameter Type Default Value Description
enterprise Integer If present, filter by scopes visible in the enterprise with this ID

Accept : scopes

Example

Delete a scope


DELETE https://example.com/api/admin/scopes/{scope}

Roles : [ROLE_USERS_MANAGE_SCOPES]

Example

Get a scope


GET https://example.com/api/admin/scopes/{scope}

Roles : [ROLE_USERS_VIEW_PRIVILEGES, ROLE_USERS_MANAGE_SCOPES, ROLE_USERS_MANAGE_USERS]

Accept : scope

Error Codes

  • SCOPE-1 - The requested scope does not exist

Example

Update a scope


PUT https://example.com/api/admin/scopes/{scope}

Roles : [ROLE_USERS_MANAGE_SCOPES]

Content-Type : scope Accept : scope

Error Codes

  • SCOPE-1 - The requested scope does not exist
  • SCOPE-10 - Cannot modify the scope to remove the enterprise. The virtual machine template is being used by virtual machines in this enterprise.
  • SCOPE-13 - Cannot modify the scope to remove the enterprise. This scope is the default for the enterprise to be removed.
  • SCOPE-18 - Invalid parent scope. You cannot set a scope as its own parent, and you cannot set a descendant's scope as a parent.
  • SCOPE-21 - Only users with an unlimited scope are allowed to make a scope unlimited

Example