Sign in
People

Create a new member

Adds a new member to the authenticated organization. The user must already exist in the system.

post/v1/people

Request body

userIdstring required

User ID to associate with this member

rolestring required

Role for the member (built-in role name or custom role ID)

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms'

Member department

isActiveboolean

Whether member is active

fleetDmLabelIdnumber

FleetDM label ID for member devices

jobTitlestring

Job title for the member

Example request

{
  "userId": "usr_abc123def456",
  "role": "admin",
  "department": "it",
  "isActive": true,
  "fleetDmLabelId": 123,
  "jobTitle": "Software Engineer"
}

Response

Member created successfully

idstring required

Member ID

organizationIdstring required

Organization ID this member belongs to

userIdstring required

User ID associated with member

rolestring required

Member role

createdAtstring date-time required

When the member was created

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms' required

Member department

jobTitleobject nullable required

Job title for the member

isActiveboolean required

Whether member is active

deactivatedboolean required

Whether member is deactivated

fleetDmLabelIdobject nullable required

FleetDM label ID for member devices

Example response

{
  "id": "mem_abc123def456",
  "organizationId": "org_abc123def456",
  "userId": "usr_abc123def456",
  "role": "admin",
  "createdAt": "2024-01-01T00:00:00Z",
  "department": "it",
  "isActive": true,
  "user": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "john.doe@company.com",
    "emailVerified": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-15T00:00:00Z"
  },
  "backgroundCheckRequests": [
    {
      "id": "bcr_abc123def456",
      "status": "invited"
    }
  ]
}

Changes

Changed in 4 of the 51 revisions of this API.114

  • 36253e8a5c1b1See the full diff
    • ○

      added the optional property backgroundCheckRequests to the response with the 201 status

      response-optional-property-added

  • 805d5411bc331See the full diff
    • ○

      added the required property deactivated to the response with the 201 status

      response-required-property-added

  • 9b8ae4b8ab6711See the full diff
    • ▲

      removed the required property user/allOf[UserResponseDto]/isPlatformAdmin from the response with the 201 status

      response-required-property-removed

    • ○

      added the required property user/allOf[UserResponseDto]/role to the response with the 201 status

      response-required-property-added

  • 946edaa856a911See the full diff
    • ●

      deleted the header request parameter X-Organization-Id

      request-parameter-removed

    • ○

      added the required property user/allOf[UserResponseDto]/isPlatformAdmin to the response with the 201 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog