Admin users

Manage admin user profiles

Download OpenAPI description

admin-users.openapi.json

admin-users.openapi.yaml

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 new admin user

Request

Adds a new admin user to Mosaic.

Security

bearer or ClientAccessToken

Bodyapplication/jsonrequired

emailstringrequired

rolesArray of stringsrequired

Roles to assign to the admin

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/admin-users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "roles": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

resultobjectrequired

result.emailobject

Primary email address, used as user identifier

result.secondary_emailsArray of objects

result.phone_numberobject

Primary phone number, used as user identifier

result.secondary_phone_numbersArray of objects

result.usernamestring

Username used to identify the user for password login (unless a primary email will be used instead). Defined only if a password was set for the user.

result.user_idstringrequired

User ID autogenerated upon user creation

result.birthdaystring(date-time)

Birthday as YYYY-MM-DD

result.addressobject

User's address

result.nameobject

Full name

result.statusstringrequired

Enum"Active""Disabled""Pending"

result.status_changed_atstring(date-time)

Date status was last updated

result.created_atnumberrequired

Date user was created in the tenant

result.updated_atnumberrequired

Date user was last updated

result.identitiesArray of objects

result.last_authstring(date-time)

Date user last authenticated

result.external_account_idstring

User identifier in an app, set by the app

result.app_namestring

Name of the app the user is associated with

result.custom_app_dataobject

Custom data object for app-related user info

result.groupIdsArray of strings

List of group IDs the user is assigned to

result.picturestring

The picture of user, specified as a URL

result.languagestring

The language of the user, as provided by the browser using the Accept-Language header field

result.custom_dataobject

Custom data object for tenant user info

result.external_user_idstring

A unique identifier in a tenant

result.password_informationobject

The information of the user's password

result.identity_providersArray of objectsDeprecated

Response

application/json

{
  "result": {
    "email": { … },
    "secondary_emails": [ … ],
    "phone_number": { … },
    "secondary_phone_numbers": [ … ],
    "username": "string",
    "user_id": "string",
    "birthday": "2019-08-24T14:15:22Z",
    "address": { … },
    "name": { … },
    "status": "Active",
    "status_changed_at": "2019-08-24T14:15:22Z",
    "created_at": 0,
    "updated_at": 0,
    "identity_providers": [ … ],
    "identities": [ … ],
    "last_auth": "2019-08-24T14:15:22Z",
    "external_account_id": "string",
    "app_name": "string",
    "custom_app_data": {},
    "groupIds": [ … ],
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "password_information": { … }
  }
}

Get a list of all admin users

Request

Retrieves a list of admin users in Mosaic.

Security

bearer or ClientAccessToken

curl -i -X GET \
  https://api.sbx.transmitsecurity.io/cis/v1/admin-users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resultArray of objectsrequired

result[].emailobject

Primary email address, used as user identifier

result[].user_idstringrequired

User ID autogenerated upon user creation

result[].statusstringrequired

Enum"Active""Disabled""Pending"

result[].created_atnumberrequired

Date user was created in the tenant

result[].updated_atnumberrequired

Date user was last updated

result[].last_authstring(date-time)

Date user last authenticated

result[].rolesArray of objects

User roles list

Response

application/json

{
  "result": [
    { … }
  ]
}

Delete admin user

Request

Deletes an admin user from Mosaic.

Security

bearer or ClientAccessToken

Path

admin_idstringrequired

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/cis/v1/admin-users/{admin_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Admin deleted successfully

Response

No content