Skip to main content

Auth User Update

PATCH 

/auth-users/:id

Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields:

  • capabilities

A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed.

Request

Path Parameters

    id stringrequired

    Identity ID

    Example: ef38f94347e94562b5bb8424a56397d8

Body

arrayrequired

A list of auth user update operations according to the JSON Patch standard.

  • Array [
  • op stringrequired

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

    path stringrequired

    A string JSON Pointer representing the target path to an element to be affected by the operation

    value object

    The value to be used for the operation, required for "add" and "replace" operations

    oneOf

    string

  • ]

Responses

Auth user updated.

Schema
    tenant string

    Tenant name.

    id string

    Identity ID.

    uid string

    Identity's unique identitifier.

    profile string

    ID of the auth profile associated with the auth user.

    identificationNumber string

    Auth user's employee number.

    email string

    Auth user's email.

    phone string

    Auth user's phone number.

    workPhone string

    Auth user's work phone number.

    personalEmail string

    Auth user's personal email.

    firstname string

    Auth user's first name.

    lastname string

    Auth user's last name.

    displayName string

    Auth user's name in displayed format.

    alias string

    Auth user's alias.

    lastPasswordChangeDate string

    Date of last password change.

    lastLoginTimestamp int64

    Timestamp of the last login (long type value).

    currentLoginTimestamp int64

    Timestamp of the current login (long type value).

    capabilities string[]

    Possible values: [CERT_ADMIN, CLOUD_GOV_ADMIN, CLOUD_GOV_USER, HELPDESK, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SAAS_MANAGEMENT_ADMIN, SAAS_MANAGEMENT_READER, SOURCE_ADMIN, SOURCE_SUBADMIN, das:ui-administrator, das:ui-compliance_manager, das:ui-auditor, das:ui-data-scope, sp:aic-dashboard-read, sp:aic-dashboard-write]

    Array of the auth user's capabilities.

Loading...