Users

View users. Users all have a single base role, and can be assigned multiple custom roles. They can be managed via your Slack workspace or SAML provider.

The user object

base_role

object

required

Show child attributes

Example:

{
  "description": "Elevated permissions for the customer success team.",
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "name": "Customer Success",
  "slug": "customer-success"
}

custom_roles

object[]

required

Show child attributes

Example:

[
  {
    "description": "Elevated permissions for the customer success team.",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Customer Success",
    "slug": "customer-success"
  }
]

string

required

Unique identifier of the user

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

name

string

required

Name of the user

Example:

"Lisa Karlin Curtis"

role

enum<string>

required

DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.

Available options:

viewer,

responder,

administrator,

owner,

unset

Example:

"owner"

seats

object

required

Show child attributes

Example:

{
  "on_call": "full_access",
  "response": "viewer_only"
}

string

Email address of the user.

Example:

"lisa@incident.io"

slack_user_id

string

Slack ID of the user

Example:

"U02AYNF2XJM"

Update

List

⌘I

{
  "base_role": {
    "description": "Elevated permissions for the customer success team.",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Customer Success",
    "slug": "customer-success"
  },
  "custom_roles": [
    {
      "description": "Elevated permissions for the customer success team.",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Customer Success",
      "slug": "customer-success"
    }
  ],
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "name": "Lisa Karlin Curtis",
  "role": "owner",
  "seats": {
    "on_call": "full_access",
    "response": "viewer_only"
  },
  "email": "lisa@incident.io",
  "slack_user_id": "U02AYNF2XJM"
}

Getting started

Webhooks

Audit logs

Deprecated endpoints

The user object

​The user object

The user object