Get custom scopes

The endpoint provides functionality to get all custom scopes.

HTTP request

GET https://$instanceId.id.nevis.cloud/nevis/api/v1/scopes

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance

Example request

curl --request GET "https://$instanceId.id.nevis.cloud/nevis/api/v1/scopes" \
  --header "Authorization: Bearer $accessKey" \
  --header "Content-Type: application/json"

HTTP response

On success

HTTP/1.1 200 is returned on success.

Parameter	Type	Description
items	array of custom scopes	The collection of custom scopes

Example response

{
    "items": [
        {
            "scopeId": "b0932408c76934c17f048dab",
            "name": "read",
            "description": "read scope"
        },
        {
            "scopeId": "a4df3236a146a4e654adf65b",
            "name": "write"
        }
    ]
}

On failure

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 500 is returned if an unexpected error occurs.