馃尶
Laurel APIs
  • Introduction
  • Guides
    • Authentication
    • Building A Connector
    • Public Api Endpoints
  • Services
    • Identity
      • Oauth
      • Users
    • Ingestion
      • Clients
      • Codes
      • Initiatives
      • Validation Rules
    • Time
      • Clients
      • Code Types
      • Codes
      • Entries
      • Initiatives
      • Validation Rules
Powered by GitBook
On this page
  1. Services
  2. Identity

Users

PreviousOauthNextIngestion

Last updated 1 month ago

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 路 enumrequired
Available options:
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/customers/{customerId}/users?integration=cloud-assistant-cdr' \
  --header 'Authorization: Bearer JWT'
200
{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "user@example.com",
  "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"
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ]
}
get
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer's id

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/customers/{customerId}/users/lookup' \
  --header 'Authorization: Bearer JWT'
200
{
  "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
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/v1/customers/{customerId}/users/{userId}' \
  --header 'Authorization: Bearer JWT'
200
{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "user@example.com",
  "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"
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ]
}

deletes a user

delete
Authorizations
Path parameters
customerIdstring 路 objectidrequired

customer's id

userIdstring 路 objectidrequired

user's id

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/api/v1/customers/{customerId}/users/{userId}' \
  --header 'Authorization: Bearer JWT'
200
{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "user@example.com",
  "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"
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ]
}
  • GETreturns all users for a customer, filtered by optional search parameter
  • GET/api/v1/customers/{customerId}/users/lookup
  • GETreturns a user by its id
  • PATCHupdates a user
  • DELETEdeletes a user

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: user@example.com
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

identitiesobject[]optional

if set, will update user's external identities

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/api/v1/customers/{customerId}/users/{userId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "delegateIds": [
      "text"
    ],
    "firstName": "text",
    "email": "user@example.com",
    "jobTitle": "text",
    "lastName": "text",
    "nickname": "text",
    "roleIds": [
      "text"
    ],
    "identities": [
      {
        "type": "aderant",
        "value": "text",
        "customerId": "text"
      }
    ]
  }'
200
{
  "_id": "text",
  "createdAt": "2022-08-12T20:44:48Z",
  "isSuperDelegate": true,
  "email": "user@example.com",
  "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"
    }
  ],
  "identities": [
    {
      "type": "aderant",
      "value": "text",
      "customerId": "text"
    }
  ],
  "roles": [
    {
      "_id": "text",
      "name": "text",
      "permissions": [
        {
          "_id": "text",
          "claim": "text",
          "description": "text"
        }
      ]
    }
  ]
}