Resources

Download OpenAPI specification:Download

Manage your resources across your tenant

Create resource

Create a resource in a specific tenant

SecurityHTTP: bearer
Request
Request Body schema: application/json
name
required
string

Name of the resource

description
string

Short description of the resource

uri
required
string
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

SecurityHTTP: bearer
Responses
200
get/v1/resources
Request samples
curl -i -X GET \
  https://api.transmitsecurity.io/cis/v1/resources \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}

Get resource by URI

Retrieve a specific resource by its URI

SecurityHTTP: bearer
Request
query Parameters
resourceUri
required
string
Responses
200
400
404
get/v1/resources/uri
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/resources/uri?resourceUri=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Update resource

Update a specific resource

SecurityHTTP: bearer
Request
path Parameters
resourceId
required
string
Request Body schema: application/json
name
string

Name of the resource

description
string

Short description of the resource

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

SecurityHTTP: bearer
Request
path Parameters
resourceId
required
string
Responses
204
404
409
delete/v1/resources/{resourceId}
Request samples
curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/resources/{resourceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Resource does not exist in tenant",
  • "error_code": 404
}