Users

This includes the users who have UI access to the Tray platform as well as the API users that you can create by issuing tokens.

Invite User to Organization Workspace

Invites a user to the organization.

This will send an email to the user with a link to create an account.

If your organization has SSO configured and you do not wish an invitation to be sent, make use of the Create User endpoint.

This endpoint is rate limited to 100 user invites per day per organization.

Request Examples

{
  "email": "string",
  "organizationRoleId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response Examples

{
  "inviteId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expires": "2023-12-01T10:00:00Z"
}

List Organization Roles

List all roles in the organization.
When managing APIs you would want to take full control of how your endpoints are accessed.
Role-based policies allow you to build clear and consistent access control.
Read this page for details on creating roles and issuing tokens.

Response Examples

{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "type": null,
      "description": "string",
      "monthlyTaskLimit": 0
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

List Users

List all users in the organization

Response Examples

{
  "elements": [
    {
      "id": "string",
      "name": "string",
      "type": null,
      "description": "string",
      "monthlyTaskLimit": 0
    }
  ],
  "pageInfo": {
    "startCursor": "string",
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Create User

Creates a user in the organization.

This endpoint should be used when you have SSO configured as it will not send an invitation to set up an account.

If an invitation is required, make use of the Invite user to organization workspace endpoint.

Request Examples

{
  "name": "string",
  "email": "string",
  "organizationRoleId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response Examples

{
  "id": "string",
  "email": "string",
  "name": "string",
  "accountType": null,
  "role": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Get User

Get user by id

Response Examples

{
  "id": "string",
  "email": "string",
  "name": "string",
  "accountType": null,
  "role": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  }
}

Delete User

Delete user by id

Response Examples

{}

Update User Role

Updates the role of a user in the organization

Request Examples

{
  "roleId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response Examples

{}