Users

returns all users for a customer, filtered by optional search parameter

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

Query parameters

searchstringOptional

searches first & last names, nickname, & email using a query

integrationstring · enumRequiredPossible values:

Responses

200Success

application/json

or

get

/api/v1/customers/{customerId}/users

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/users?integration=cloud-assistant-cdr HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "[email protected]",
  "firstName": "text",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "updatedAt": "2022-08-12T20:44:48Z",
  "status": "active",
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "groupIds": [
    "text"
  ],
  "customer": {
    "_id": "text",
    "fullName": "text",
    "tenant": {
      "_id": "text",
      "description": "text",
      "name": "iad"
    },
    "customerSegment": "strategic",
    "vertical": "legal"
  },
  "delegators": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "identities": [
        {
          "type": "aderant",
          "value": "text",
          "customerId": "text"
        }
      ]
    }
  ],
  "delegates": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "permissions": {}
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ],
  "superDelegatePermissions": {}
}

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

Responses

200Success

application/json

typestring · enumRequired

type of the external identity

Possible values:

valuestringRequired

external identifier

customerIdstring · objectidOptional

optional customer id to bind the identity to

get

/api/v1/customers/{customerId}/users/lookup

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/users/lookup HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "type": "aderant",
  "value": "text",
  "customerId": "text"
}

returns a user by its id

get

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Responses

200Success

application/json

_idstring · objectidRequired

user's id

createdAtstring · iso-date-timeRequired

date and time user was created

Example: 2022-08-12T20:44:48Z

isSuperDelegatebooleanOptional

emailstring · emailRequired

user's email address used for login

Example: [email protected]

firstNamestringRequired

user's first name

jobTitlestringRequired

user's job title

lastNamestringRequired

user's last name

nicknamestringRequired

user's nickname, can be empty

updatedAtstring · iso-date-timeRequired

date and time user was last updated

Example: 2022-08-12T20:44:48Z

statusstring · enumOptionalPossible values:

senioritystringOptional

user's seniority level

departmentstringOptional

user's department

officestringOptional

user's office

subdepartmentstringOptional

user's subdepartment

podstringOptional

user's pod

groupIdsstring · objectid[] · nullableOptional

user group ids that this user belongs to

superDelegatePermissionsobjectOptional

list of permissions assigned to Super Delegates

get

/api/v1/customers/{customerId}/users/{userId}

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "[email protected]",
  "firstName": "text",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "updatedAt": "2022-08-12T20:44:48Z",
  "status": "active",
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "groupIds": [
    "text"
  ],
  "customer": {
    "_id": "text",
    "fullName": "text",
    "tenant": {
      "_id": "text",
      "description": "text",
      "name": "iad"
    },
    "customerSegment": "strategic",
    "vertical": "legal"
  },
  "delegators": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "identities": [
        {
          "type": "aderant",
          "value": "text",
          "customerId": "text"
        }
      ]
    }
  ],
  "delegates": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "permissions": {}
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ],
  "superDelegatePermissions": {}
}

updates a user

patch

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Body

application/json

delegateIdsstring · objectid[]Optional

if set, will update users who delegate their work to this user

firstNamestringOptional

if set, will update user's first name

emailstring · emailOptional

if set, will update user's email

Example: [email protected]

jobTitlestringOptional

if set, will update user's job title

lastNamestringOptional

if set, will update user's last name

nicknamestringOptional

if set, will update user's nickname, can be empty

roleIdsstring · objectid[]Optional

if set, will update roles that are assigned to the user

senioritystringOptional

if set, will update user's seniority level

departmentstringOptional

if set, will update user's department

officestringOptional

if set, will update user's office

subdepartmentstringOptional

if set, will update user's subdepartment

podstringOptional

if set, will update user's pod

Responses

200Success

application/json

_idstring · objectidRequired

user's id

createdAtstring · iso-date-timeRequired

date and time user was created

Example: 2022-08-12T20:44:48Z

isSuperDelegatebooleanOptional

emailstring · emailRequired

user's email address used for login

Example: [email protected]

firstNamestringRequired

user's first name

jobTitlestringRequired

user's job title

lastNamestringRequired

user's last name

nicknamestringRequired

user's nickname, can be empty

updatedAtstring · iso-date-timeRequired

date and time user was last updated

Example: 2022-08-12T20:44:48Z

statusstring · enumOptionalPossible values:

senioritystringOptional

user's seniority level

departmentstringOptional

user's department

officestringOptional

user's office

subdepartmentstringOptional

user's subdepartment

podstringOptional

user's pod

groupIdsstring · objectid[] · nullableOptional

user group ids that this user belongs to

superDelegatePermissionsobjectOptional

list of permissions assigned to Super Delegates

patch

/api/v1/customers/{customerId}/users/{userId}

HTTPcURLJavaScriptPython

PATCH /api/v1/customers/{customerId}/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "delegateIds": [
    "text"
  ],
  "firstName": "text",
  "email": "[email protected]",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "roleIds": [
    "text"
  ],
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ]
}

200Success

{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "[email protected]",
  "firstName": "text",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "updatedAt": "2022-08-12T20:44:48Z",
  "status": "active",
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "groupIds": [
    "text"
  ],
  "customer": {
    "_id": "text",
    "fullName": "text",
    "tenant": {
      "_id": "text",
      "description": "text",
      "name": "iad"
    },
    "customerSegment": "strategic",
    "vertical": "legal"
  },
  "delegators": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "identities": [
        {
          "type": "aderant",
          "value": "text",
          "customerId": "text"
        }
      ]
    }
  ],
  "delegates": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "permissions": {}
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ],
  "superDelegatePermissions": {}
}

deletes a user

delete

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Query parameters

isForwardedbooleanOptional

originalPrincipalClientIdstringOptional

originalPrincipalCustomerIdstringOptional

originalPrincipalUserIdstringOptional

Responses

200Success

application/json

_idstring · objectidRequired

user's id

createdAtstring · iso-date-timeRequired

date and time user was created

Example: 2022-08-12T20:44:48Z

isSuperDelegatebooleanOptional

emailstring · emailRequired

user's email address used for login

Example: [email protected]

firstNamestringRequired

user's first name

jobTitlestringRequired

user's job title

lastNamestringRequired

user's last name

nicknamestringRequired

user's nickname, can be empty

updatedAtstring · iso-date-timeRequired

date and time user was last updated

Example: 2022-08-12T20:44:48Z

statusstring · enumOptionalPossible values:

senioritystringOptional

user's seniority level

departmentstringOptional

user's department

officestringOptional

user's office

subdepartmentstringOptional

user's subdepartment

podstringOptional

user's pod

groupIdsstring · objectid[] · nullableOptional

user group ids that this user belongs to

superDelegatePermissionsobjectOptional

list of permissions assigned to Super Delegates

delete

/api/v1/customers/{customerId}/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/v1/customers/{customerId}/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "[email protected]",
  "firstName": "text",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "updatedAt": "2022-08-12T20:44:48Z",
  "status": "active",
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "groupIds": [
    "text"
  ],
  "customer": {
    "_id": "text",
    "fullName": "text",
    "tenant": {
      "_id": "text",
      "description": "text",
      "name": "iad"
    },
    "customerSegment": "strategic",
    "vertical": "legal"
  },
  "delegators": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "identities": [
        {
          "type": "aderant",
          "value": "text",
          "customerId": "text"
        }
      ]
    }
  ],
  "delegates": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "permissions": {}
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ],
  "superDelegatePermissions": {}
}

patch

Authorizations

ApiBearerAuth

AuthorizationstringRequired

Enter access token

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Body

application/json

firstNamestringOptional

if set, will update user's first name

emailstring · emailOptional

if set, will update user's email

Example: [email protected]

jobTitlestringOptional

if set, will update user's job title

lastNamestringOptional

if set, will update user's last name

nicknamestringOptional

if set, will update user's nickname, can be empty

roleIdsstring · objectid[]Optional

if set, will update roles that are assigned to the user

senioritystringOptional

if set, will update user's seniority level

departmentstringOptional

if set, will update user's department

officestringOptional

if set, will update user's office

subdepartmentstringOptional

if set, will update user's subdepartment

podstringOptional

if set, will update user's pod

Responses

200Success

application/json

_idstring · objectidRequired

user's id

createdAtstring · iso-date-timeRequired

date and time user was created

Example: 2022-08-12T20:44:48Z

isSuperDelegatebooleanOptional

emailstring · emailRequired

user's email address used for login

Example: [email protected]

firstNamestringRequired

user's first name

jobTitlestringRequired

user's job title

lastNamestringRequired

user's last name

nicknamestringRequired

user's nickname, can be empty

updatedAtstring · iso-date-timeRequired

date and time user was last updated

Example: 2022-08-12T20:44:48Z

statusstring · enumOptionalPossible values:

senioritystringOptional

user's seniority level

departmentstringOptional

user's department

officestringOptional

user's office

subdepartmentstringOptional

user's subdepartment

podstringOptional

user's pod

groupIdsstring · objectid[] · nullableOptional

user group ids that this user belongs to

superDelegatePermissionsobjectOptional

list of permissions assigned to Super Delegates

patch

/api/v2/customers/{customerId}/users/{userId}

HTTPcURLJavaScriptPython

PATCH /api/v2/customers/{customerId}/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "firstName": "text",
  "email": "[email protected]",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "roleIds": [
    "text"
  ],
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "delegates": [
    {
      "userId": "text",
      "permissions": [
        {
          "claim": "text"
        }
      ]
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ]
}

200Success

{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "[email protected]",
  "firstName": "text",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "updatedAt": "2022-08-12T20:44:48Z",
  "status": "active",
  "seniority": "text",
  "department": "text",
  "office": "text",
  "subdepartment": "text",
  "pod": "text",
  "groupIds": [
    "text"
  ],
  "customer": {
    "_id": "text",
    "fullName": "text",
    "tenant": {
      "_id": "text",
      "description": "text",
      "name": "iad"
    },
    "customerSegment": "strategic",
    "vertical": "legal"
  },
  "delegators": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "identities": [
        {
          "type": "aderant",
          "value": "text",
          "customerId": "text"
        }
      ]
    }
  ],
  "delegates": [
    {
      "_id": "text",
      "firstName": "text",
      "lastName": "text",
      "permissions": {}
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ],
  "superDelegatePermissions": {}
}