Management Apps

Download OpenAPI specification:Download

View, create, and update your management applications. These are typically backend services accessing our platform to perform administrative actions. They can be used to generate client credentials that have tenant-level access to users, roles, apps, settings, and more.

Create management app

Create a management application

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

Name of the application

app_description
string

Short description of the application

Responses
201
400
post/v1/management/applications
Request samples
application/json
{
  • "app_name": "My App",
  • "app_description": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Get management apps

Retrieve a list of all management applications

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

Update management app

Update a management application

SecurityHTTP: bearer
Request
path Parameters
app_id
required
string
Request Body schema: application/json
app_name
string

Name of the application

app_description
string

Short description of the application

Responses
200
400
404
put/v1/management/applications/{app_id}
Request samples
application/json
{
  • "app_name": "My App",
  • "app_description": "string"
}
Response samples
application/json
{
  • "result": {
    }
}

Delete management app

Delete a management application and remove role assignments belonging to it.

SecurityHTTP: bearer
Request
path Parameters
app_id
required
string
Responses
204
400
404
delete/v1/management/applications/{app_id}
Request samples
curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/management/applications/{app_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}