Resources

Download OpenAPI specification:Download

Manage your resources across your tenant. Once a resource is added to the relevant app, it can be specified in an authentication request in order to grant the user access to only this resource.

Create resource

Create a resource in a specific tenant.

Required permissions: resources:create, apps:create, [appId]:create.

SecurityOAuth2: ClientAccessToken
Request
Request Body schema: application/json
required
name
required
string

Name of the resource

description
string

Short description of the resource

uri
required
string

URI that identifies the resource, which is reflected in the audience (aud claim) of the access token

access_token_ttl
required
number

Access token expiration in seconds

refresh_token_ttl
required
number

Refresh token expiration in seconds

max_refresh_rotate
required
number

Absolute lifetime of a refresh token in seconds, after which it can no longer be used or rotated

Responses
201
400
post/v1/resources
Request samples
application/json
{
  • "name": "My Resource",
  • "description": "string",
  • "uri": "string",
  • "access_token_ttl": 0,
  • "refresh_token_ttl": 0,
  • "max_refresh_rotate": 0
}
Response samples
application/json
{
  • "result": {
    }
}

Get resources

Retrieve all resources created in the tenant.

Required permissions: resources:list, resources:read.

SecurityOAuth2: ClientAccessToken
Responses
200
get/v1/resources
Request samples 
Response samples 
application/json
{
  • "result": [
    ]
}
Get resource by URI
Retrieve a specific resource by its URI. 

Required permissions: resources:read, apps:read, [appId]:read.


SecurityOAuth2: ClientAccessToken 
Request 
query Parameters
resourceUri
required
string
 
Responses 
200
400
404
get/v1/resources/uri
Request samples 
Response samples 
application/json
{
  • "result": {
    }
}
Update resource
Update a specific resource. 

Required permissions: resources:edit, apps:edit, [appId]:edit.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
resourceId
required
string
 
Request Body schema: application/json
required
name
string
Name of the resource


 
description
string
Short description of the resource


 
uri
string
URI that identifies the resource, which is reflected in the audience (aud claim) of the access token


 
access_token_ttl
number
Access token expiration in seconds


 
refresh_token_ttl
number
Refresh token expiration in seconds


 
max_refresh_rotate
number
Absolute lifetime of a refresh token in seconds, after which it can no longer be used or rotated


 
Responses 
200
400
404
put/v1/resources/{resourceId}
Request samples 
application/json
{
  • "name": "My Resource",
  • "description": "string",
  • "uri": "string",
  • "access_token_ttl": 0,
  • "refresh_token_ttl": 0,
  • "max_refresh_rotate": 0
}
Response samples 
application/json
{
  • "result": {
    }
}
Delete resource
Delete a specific resource. 

Required permissions: resources:delete, apps:delete, [appId]:delete.


SecurityOAuth2: ClientAccessToken 
Request 
path Parameters
resourceId
required
string
 
Responses 
204
404
409
delete/v1/resources/{resourceId}
Request samples 
Response samples 
application/json
{
  • "message": "Resource does not exist in tenant",
  • "error_code": 404
}