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.
{- "app_name": "My App",
- "app_description": "string"
}
{- "result": {
- "app_id": "string",
- "tenant_id": "string",
- "app_name": "string",
- "app_description": "string",
- "client_type": "web",
- "logo": "string",
- "client_id": "string",
- "client_display_name": "string",
- "client_description": "string",
- "client_secret": "string",
- "redirect_uris": [
- "string"
], - "login_preferences": {
- "auth_methods": {
- "google": {
- "clientId": "string",
- "clientSecret": "string"
}, - "facebook": {
- "clientId": "string",
- "clientSecret": "string"
}, - "email": {
- "expiresIn": 0,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}
}, - "email_otp": {
- "expiresIn": 0,
- "maxFailures": 3,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}
}, - "apple": {
- "clientId": "string",
- "clientSecret": "string",
- "appleTeamId": "string",
- "keyId": "string"
}, - "sms": {
- "expiresIn": 0,
- "maxFailures": 3
}, - "webauthn": {
- "clientId": "string",
- "clientSecret": "string"
}, - "webauthn_api": {
- "rpId": "string",
- "rpOrigin": "string"
}, - "line": {
- "clientId": "string",
- "clientSecret": "string"
}, - "password": {
- "resetValidityMinutes": 5,
- "passwordComplexity": 5,
- "passwordMinLength": 14,
- "blockPreviousPasswords": 0,
- "passwordExpiresIn": 90,
- "maxPasswordFailures": 5,
- "passwordSuspensionDuration": 15,
- "failuresExpireIn": 15,
- "tempPasswordValidityHours": 24,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}, - "requireMFA": false
}
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "service_providers": [
- "string"
], - "authenticator_preferences": {
- "is_centralized": false,
}, - "allow_public_signup": true,
- "client_auth_method": "client_secret_basic",
- "device_authorization": {
- "enabled": false,
}, - "password_sharing_group_id": "string"
}
}
Retrieve a list of all management applications
curl -i -X GET \ https://api.transmitsecurity.io/cis/v1/management/applications \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": [
- {
- "app_id": "string",
- "tenant_id": "string",
- "app_name": "string",
- "app_description": "string",
- "client_type": "web",
- "client_id": "string",
- "client_display_name": "string",
- "client_description": "string",
- "client_secret": "string",
- "redirect_uris": [
- "string"
], - "login_preferences": {
- "auth_methods": {
- "google": {
- "clientId": "string",
- "clientSecret": "string"
}, - "facebook": {
- "clientId": "string",
- "clientSecret": "string"
}, - "email": {
- "expiresIn": 0,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}
}, - "email_otp": {
- "expiresIn": 0,
- "maxFailures": 3,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}
}, - "apple": {
- "clientId": "string",
- "clientSecret": "string",
- "appleTeamId": "string",
- "keyId": "string"
}, - "sms": {
- "expiresIn": 0,
- "maxFailures": 3
}, - "webauthn": {
- "clientId": "string",
- "clientSecret": "string"
}, - "webauthn_api": {
- "rpId": "string",
- "rpOrigin": "string"
}, - "line": {
- "clientId": "string",
- "clientSecret": "string"
}, - "password": {
- "resetValidityMinutes": 5,
- "passwordComplexity": 5,
- "passwordMinLength": 14,
- "blockPreviousPasswords": 0,
- "passwordExpiresIn": 90,
- "maxPasswordFailures": 5,
- "passwordSuspensionDuration": 15,
- "failuresExpireIn": 15,
- "tempPasswordValidityHours": 24,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}, - "requireMFA": false
}
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "service_providers": [
- "string"
], - "authenticator_preferences": {
- "is_centralized": false,
}, - "allow_public_signup": true,
- "client_auth_method": "client_secret_basic",
- "device_authorization": {
- "enabled": false,
}, - "password_sharing_group_id": "string"
}
]
}
{- "app_name": "My App",
- "app_description": "string"
}
{- "result": {
- "app_id": "string",
- "tenant_id": "string",
- "app_name": "string",
- "app_description": "string",
- "client_type": "web",
- "logo": "string",
- "client_id": "string",
- "client_display_name": "string",
- "client_description": "string",
- "client_secret": "string",
- "redirect_uris": [
- "string"
], - "login_preferences": {
- "auth_methods": {
- "google": {
- "clientId": "string",
- "clientSecret": "string"
}, - "facebook": {
- "clientId": "string",
- "clientSecret": "string"
}, - "email": {
- "expiresIn": 0,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}
}, - "email_otp": {
- "expiresIn": 0,
- "maxFailures": 3,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}
}, - "apple": {
- "clientId": "string",
- "clientSecret": "string",
- "appleTeamId": "string",
- "keyId": "string"
}, - "sms": {
- "expiresIn": 0,
- "maxFailures": 3
}, - "webauthn": {
- "clientId": "string",
- "clientSecret": "string"
}, - "webauthn_api": {
- "rpId": "string",
- "rpOrigin": "string"
}, - "line": {
- "clientId": "string",
- "clientSecret": "string"
}, - "password": {
- "resetValidityMinutes": 5,
- "passwordComplexity": 5,
- "passwordMinLength": 14,
- "blockPreviousPasswords": 0,
- "passwordExpiresIn": 90,
- "maxPasswordFailures": 5,
- "passwordSuspensionDuration": 15,
- "failuresExpireIn": 15,
- "tempPasswordValidityHours": 24,
- "message": {
- "primaryColor": "string",
- "from": "string",
- "subject": "string"
}, - "requireMFA": false
}
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "created_by": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "resources": [
- "string"
], - "service_providers": [
- "string"
], - "authenticator_preferences": {
- "is_centralized": false,
}, - "allow_public_signup": true,
- "client_auth_method": "client_secret_basic",
- "device_authorization": {
- "enabled": false,
}, - "password_sharing_group_id": "string"
}
}
Delete a management application and remove role assignments belonging to it.
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/management/applications/{app_id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "message": "Bad request",
- "error_code": 400
}