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",
  "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"
}

post

Authorizations

Path parameters

customerIdstring · objectidRequired

customer's id

Body

emailstringRequiredExample: email address of the user

identityTypestringRequiredExample: Identity type of the user

Responses

200Success

application/json

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/customers/{customerId}/users/lookup/identity HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "email": "email address of the user",
  "identityType": "Identity type of the user"
}

{
  "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",
  "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

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: 212

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

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: 254

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