Users

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

get

Authorizations

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

Responseone of

or

get

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/users?integration=cloud-assistant-cdr HTTP/1.1
Host: 
Authorization: Bearer JWT
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",
  "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

Path parameters

customerIdstring · objectidRequired

customer's id

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

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

returns a user by its id

get

Authorizations

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customers/{customerId}/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer JWT
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",
  "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

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Body

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

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "delegateIds": [
    "text"
  ],
  "firstName": "text",
  "email": "[email protected]",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "roleIds": [
    "text"
  ],
  "seniority": "text",
  "department": "text",
  "office": "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",
  "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

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Responses

200Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/customers/{customerId}/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer JWT
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",
  "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

Path parameters

customerIdstring · objectidRequired

customer's id

userIdstring · objectidRequired

user's id

Body

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

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "firstName": "text",
  "email": "[email protected]",
  "jobTitle": "text",
  "lastName": "text",
  "nickname": "text",
  "roleIds": [
    "text"
  ],
  "seniority": "text",
  "department": "text",
  "office": "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",
  "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": {}
}