User Roles on the Signiant Platform

The Signiant Platform allows users to hold different permission levels based on roles assigned to a user. When a user logs in to the Signiant Console, the user profile is called by the platform which is associated with the user's roles, which allow access to specific products or services at a time.

Note: Media Shuttle IT Administrators cannot be provisioned using the Signiant Platform API. To add or remove IT Administrators to your account, contact Signiant Customer Care.

When using the API, the client_id, client_secret, and generated JWT bearer token used to access the API are scoped to a single role for a single product.

To add, remove, and update users, you must use the /v1/users endpoint with the JWT bearer token generated from the client_id and client_secret that correspond to the necessary role for the related product.

Note: API usage is not associated with a specific user or email address. The client_id is used to log API activity.

Examples

Creating Users

To create a new user, or assign a role to an existing user, send a POST request to the /v1/users/{email_address}/roles endpoint with the role as the request body.

Note: Creating a new user sends an automated email to the user, prompting them to set a password for their Signiant Console account.

Example Request

{
  "role": "MEDIA_ENGINE_USER"
}

Example Response

{
  "roleId": "31cd79a8-bbbb-bbbb-bbbb-e3465b4e8ee4",
  "role": "MEDIA_ENGINE_USER",
  "createdOn": "2024-04-20T18:43:53.747Z"
}

To assign additional roles to a user, send an additional POST request with the required role. For a list of valid role types, see the Service and Role Reference.

Listing Users

To list existing users and their associated roles, send a GET request to the /v1/users endpoint.

Example Response

{
  "items": [
    {
      "emailAddress": "user@example.com",
      "roles": {
        "items": [
          {
            "roleId": "c8e187a6-aaaa-aaaa-aaaa-6e6625176e4a",
            "role": "MEDIA_ENGINE_IT_ADMIN",
            "createdOn": "2024-04-20T17:06:26.284Z"
          },
          {
            "roleId": "6a275d61-bbbb-bbbb-bbbb-35e466289624",
            "role": "MEDIA_ENGINE_USER",
            "createdOn": "2024-04-20T18:43:53.747Z"
          }
        ]
      }
    }
  ]
}

Removing Users

To remove a user, you must remove their role using their roleId. Send a DELETE request to the /v1/users/{email_address}/roles/{roleId} endpoint.

Example Response

{
  "roleId": "31cd79a8-bbbb-bbbb-bbbb-e3465b4e8ee4",
  "role": "MEDIA_ENGINE_USER",
  "createdOn": "2024-04-20T18:43:53.747Z"
}

Note: At least one administrator must be assigned to an account.

Service and Role Reference