Subscriptions

Get a user under specified subscription.

get/api/v1/subscriptions/{subscriptionId}/users/{userId}

Request

  • Base URL: https://api.chiligrafx.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.chiligrafx.com/api/v1/subscriptions/{subscriptionId}/users/{userId}
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring uuid required

Subscription Id.

userIdstring required

User Id.

Response

Returns a user under specified subscription.

idstring required

User Id.

emailstring required

User email.

firstNamestring nullable

User first name.

lastNamestring nullable

User last name.

avatarstring nullable

Link to avatar picture.

lastSeeninteger nullable

Last login datetime in seconds (unit timestamp).

status'Active' | 'Blocked' | 'Pending' | 'Inactive'

Status of a user.

subscriptionRolesstring[] nullable

Subscription roles.

environmentRolesobject nullable

Environment roles.

hasFullAccessboolean required

If a user is a Chili Administrator.

createdAtinteger nullable

The datetime of user creation in seconds (unix timestamp).

isFederatedboolean

Is user federated.

membershipType'Invitation' | 'Federated'

Example response

{
  "id": "auth0|630f8c2b524936fea93c0e75",
  "email": "simple@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "avatar": "https://example.com/some-image.png",
  "lastSeen": 1668540708,
  "subscriptionRoles": [
    "TD",
    "SA"
  ],
  "environmentRoles": {
    "ba8d5ad0-2ca0-4bae-8cab-da8d4f28425e": [
      "EA",
      "CA"
    ],
    "f5357acf-ce44-4393-8933-2d1a64b2a973": [
      "EU"
    ]
  },
  "createdAt": 1668540708,
  "isFederated": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.