Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Users

5 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List Users

GET/api/v1/users/

API key permissionUser: Read-onlyuser:read

Query parameters

  • pageinteger

    Default 1 · Min 1

  • page_sizeinteger

    Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedUserResponseSchema

  • itemsarray of objectrequired
    Items · UserResponseSchema
    • idstring · uuidrequired
    • groupsarray of stringrequired
    • workspacesarray of string · uuidrequired
    • workspace_namesarray of stringrequired
    • activebooleanrequired
    • createdstring · date-timerequired
    • last_loginstring · date-timenullable
      Attributes

      • string · date-time

      • null

    • last_modifiedstring · date-timenullable

      Timestamp of the most recent edit recorded in the Django admin audit log. Covers modifications made through the admin UI (the primary admin user-management surface). Does not reflect API-driven (PATCH /api/v1/users/{id}/), SSO/auto-provisioned, or self-service profile edits. Null if the user has never been edited in admin.

      Attributes

      • string · date-time

      • null

    • emailstringrequired

      Max length 254

    • first_namestringnullable
      Attributes

      • string

      • null

    • last_namestringnullable
      Attributes

      • string

      • null

  • countintegerrequired

Create User

POST/api/v1/users/

API key permissionUser: Writeuser:write

Request bodyrequired

application/json

Body schema

object UserCreateSchema

  • emailstring · emailrequired
  • first_namestringnullable
    Attributes

    • string

    • null

  • last_namestringnullable
    Attributes

    • string

    • null

  • groupsarray of string

    Default []

  • workspacesarray of string · uuid

    Default []

  • activebooleannullable

    Default true

    Attributes

    • boolean

    • null

Responses

201Createdapplication/json

Response schema

object UserResponseSchema

  • idstring · uuidrequired
  • groupsarray of stringrequired
  • workspacesarray of string · uuidrequired
  • workspace_namesarray of stringrequired
  • activebooleanrequired
  • createdstring · date-timerequired
  • last_loginstring · date-timenullable
    Attributes

    • string · date-time

    • null

  • last_modifiedstring · date-timenullable

    Timestamp of the most recent edit recorded in the Django admin audit log. Covers modifications made through the admin UI (the primary admin user-management surface). Does not reflect API-driven (PATCH /api/v1/users/{id}/), SSO/auto-provisioned, or self-service profile edits. Null if the user has never been edited in admin.

    Attributes

    • string · date-time

    • null

  • emailstringrequired

    Max length 254

  • first_namestringnullable
    Attributes

    • string

    • null

  • last_namestringnullable
    Attributes

    • string

    • null

Get User

GET/api/v1/users/{user_id}/

API key permissionUser: Read-onlyuser:read

Path parameters

  • user_idstring · uuidrequired

Responses

200OKapplication/json

Response schema

object UserResponseSchema

  • idstring · uuidrequired
  • groupsarray of stringrequired
  • workspacesarray of string · uuidrequired
  • workspace_namesarray of stringrequired
  • activebooleanrequired
  • createdstring · date-timerequired
  • last_loginstring · date-timenullable
    Attributes

    • string · date-time

    • null

  • last_modifiedstring · date-timenullable

    Timestamp of the most recent edit recorded in the Django admin audit log. Covers modifications made through the admin UI (the primary admin user-management surface). Does not reflect API-driven (PATCH /api/v1/users/{id}/), SSO/auto-provisioned, or self-service profile edits. Null if the user has never been edited in admin.

    Attributes

    • string · date-time

    • null

  • emailstringrequired

    Max length 254

  • first_namestringnullable
    Attributes

    • string

    • null

  • last_namestringnullable
    Attributes

    • string

    • null

Update User

PATCH/api/v1/users/{user_id}/

API key permissionUser: Writeuser:write

Path parameters

  • user_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

object UserUpdateSchema

  • emailstring · emailnullable
    Attributes

    • string · email

    • null

  • first_namestringnullable
    Attributes

    • string

    • null

  • last_namestringnullable
    Attributes

    • string

    • null

  • groupsarray of string

    Default []

  • workspacesarray of string · uuid

    Default []

  • activebooleannullable
    Attributes

    • boolean

    • null

Responses

200OKapplication/json

Response schema

object UserResponseSchema

  • idstring · uuidrequired
  • groupsarray of stringrequired
  • workspacesarray of string · uuidrequired
  • workspace_namesarray of stringrequired
  • activebooleanrequired
  • createdstring · date-timerequired
  • last_loginstring · date-timenullable
    Attributes

    • string · date-time

    • null

  • last_modifiedstring · date-timenullable

    Timestamp of the most recent edit recorded in the Django admin audit log. Covers modifications made through the admin UI (the primary admin user-management surface). Does not reflect API-driven (PATCH /api/v1/users/{id}/), SSO/auto-provisioned, or self-service profile edits. Null if the user has never been edited in admin.

    Attributes

    • string · date-time

    • null

  • emailstringrequired

    Max length 254

  • first_namestringnullable
    Attributes

    • string

    • null

  • last_namestringnullable
    Attributes

    • string

    • null

Delete User

DELETE/api/v1/users/{user_id}/

API key permissionUser: Writeuser:write

Path parameters

  • user_idstring · uuidrequired

Responses

200OK