Skip to content

Resources

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.

Download OpenAPI description
resources.openapi.json
resources.openapi.yaml
Languages
Servers
Sandbox environment
https://api.sbx.transmitsecurity.io/cis/
Production environment (US)
https://api.transmitsecurity.io/cis/
Production environment (EU)
https://api.eu.transmitsecurity.io/cis/
Production environment (CA)
https://api.ca.transmitsecurity.io/cis/
Production environment (AU)
https://api.au.transmitsecurity.io/cis/

Create resource

Request

Create a resource in a specific tenant.

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

Security
ClientAccessToken
Bodyapplication/jsonrequired
namestringrequired

Name of the resource

Example: "My Resource"
descriptionstring

Short description of the resource

uristringrequired

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

access_token_ttlnumberrequired

Access token expiration in seconds

refresh_token_ttlnumberrequired

Refresh token expiration in seconds

max_refresh_rotatenumberrequired

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

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/resources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Resource",
    "description": "string",
    "uri": "string",
    "access_token_ttl": 0,
    "refresh_token_ttl": 0,
    "max_refresh_rotate": 0
  }'

Responses

Bodyapplication/json
resultobjectrequired
result.​resource_idstringrequired

Resource ID

result.​tenant_idstringrequired

Tenant ID

result.​namestringrequired

Resource friendly name

result.​descriptionstring

Resource description

result.​uristringrequired

Resource URI

result.​access_token_ttlnumberrequired

Access token expiration in seconds

result.​refresh_token_ttlnumberrequired

Refresh token expiration in seconds

result.​max_refresh_rotatenumberrequired

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

result.​created_atstring(date-time)required

Date the resource was created

result.​updated_atstring(date-time)required

Date the resource was last updated

Response
application/json
{
  "result": {
    "resource_id": "string",
    "tenant_id": "string",
    "name": "string",
    "description": "string",
    "uri": "string",
    "access_token_ttl": 0,
    "refresh_token_ttl": 0,
    "max_refresh_rotate": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Get resources

Request

Retrieve all resources created in the tenant.

Required permissions: resources:list, resources:read.

Security
ClientAccessToken
curl -i -X GET \
  https://api.sbx.transmitsecurity.io/cis/v1/resources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objectsrequired
result[].​resource_idstringrequired

Resource ID

result[].​tenant_idstringrequired

Tenant ID

result[].​namestringrequired

Resource friendly name

result[].​descriptionstring

Resource description

result[].​uristringrequired

Resource URI

result[].​access_token_ttlnumberrequired

Access token expiration in seconds

result[].​refresh_token_ttlnumberrequired

Refresh token expiration in seconds

result[].​max_refresh_rotatenumberrequired

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

result[].​created_atstring(date-time)required

Date the resource was created

result[].​updated_atstring(date-time)required

Date the resource was last updated

Response
application/json
{
  "result": [
    { … }
  ]
}

Get resource by URI

Request

Retrieve a specific resource by its URI.

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

Security
ClientAccessToken
Query
resourceUristringrequired
curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/resources/uri?resourceUri=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobjectrequired
result.​resource_idstringrequired

Resource ID

result.​tenant_idstringrequired

Tenant ID

result.​namestringrequired

Resource friendly name

result.​descriptionstring

Resource description

result.​uristringrequired

Resource URI

result.​access_token_ttlnumberrequired

Access token expiration in seconds

result.​refresh_token_ttlnumberrequired

Refresh token expiration in seconds

result.​max_refresh_rotatenumberrequired

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

result.​created_atstring(date-time)required

Date the resource was created

result.​updated_atstring(date-time)required

Date the resource was last updated

Response
application/json
{
  "result": {
    "resource_id": "string",
    "tenant_id": "string",
    "name": "string",
    "description": "string",
    "uri": "string",
    "access_token_ttl": 0,
    "refresh_token_ttl": 0,
    "max_refresh_rotate": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Update resource

Request

Update a specific resource.

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

Security
ClientAccessToken
Path
resourceIdstringrequired
Bodyapplication/jsonrequired
namestring

Name of the resource

Example: "My Resource"
descriptionstring

Short description of the resource

uristring

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

access_token_ttlnumber

Access token expiration in seconds

refresh_token_ttlnumber

Refresh token expiration in seconds

max_refresh_rotatenumber

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

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/resources/{resourceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Resource",
    "description": "string",
    "uri": "string",
    "access_token_ttl": 0,
    "refresh_token_ttl": 0,
    "max_refresh_rotate": 0
  }'

Responses

Bodyapplication/json
resultobjectrequired
result.​resource_idstringrequired

Resource ID

result.​tenant_idstringrequired

Tenant ID

result.​namestringrequired

Resource friendly name

result.​descriptionstring

Resource description

result.​uristringrequired

Resource URI

result.​access_token_ttlnumberrequired

Access token expiration in seconds

result.​refresh_token_ttlnumberrequired

Refresh token expiration in seconds

result.​max_refresh_rotatenumberrequired

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

result.​created_atstring(date-time)required

Date the resource was created

result.​updated_atstring(date-time)required

Date the resource was last updated

Response
application/json
{
  "result": {
    "resource_id": "string",
    "tenant_id": "string",
    "name": "string",
    "description": "string",
    "uri": "string",
    "access_token_ttl": 0,
    "refresh_token_ttl": 0,
    "max_refresh_rotate": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

Delete resource

Request

Delete a specific resource.

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

Security
ClientAccessToken
Path
resourceIdstringrequired
curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/resources/{resourceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content