Skip to main content

Update a user

PUT 
/api/web/v3/users/:id

Update the specified user. Caller requires the USERS:EDIT permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the user to be updated.

Body

required

    applyGracePeriod boolean

    Indicates if the user is granted a new frozen grace period. This value is not used when creating a user. If provided, it will be ignored.

    email string

    The email address of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. It must be set to use EMAIL OTP authentication and other features that require an email address. To remove the existing value, set the value to an empty string.

    emailVerification boolean

    Indicates if a verification email message should be sent to the user if the user now requires verification. The user's policy requiring user verification must also be enabled for the user. If not set, this value defaults to true.

    externalId string

    An optional external ID for this user. This value can be used to track the external identity of an Identity as a Service user. To unset the external ID, specify an empty string.

    externalSource string

    An optional value that describes the source when the user is synchronized from an external source. To unset the external source, specify an empty string.

    firstName string

    The first name of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. To remove the existing value, set the value to an empty string.

    groups string[]

    A list of group UUIDs to be assigned to this user. If specified, these groups replace existing groups.

    lastName string

    The last name of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. To remove the existing value, set the value to an empty string.

    locale string

    Possible values: [da, de, en, es, fr, it, ja, ko, nl, nb, pl, pt, ru, sv, th, tr, zh-cn, zh-tw]

    The locale of this user. If not set, the default account locale will be used. To remove the existing value, set the value to an empty string.

    lock boolean

    Indicates if all the user's authenticators are locked or not.

    mobile string

    The mobile number of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. It must be set to use SMS OTP authentication. To remove the existing value, set the value to an empty string.

    oauthRoles string[]

    A list of oauth role UUIDs to be assigned to this user. If specified, these oauth roles replace existing oauth roles.

    organizations string[]

    A list of organization UUIDs to be assigned to this user. If specified, these organizations replace existing organizations.

    phone string

    The phone number of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. It must be set to use VOICE OTP authentication. To remove the existing value, set the value to an empty string.

    preferredOtpDelivery string

    Possible values: [EMAIL, SMS, VOICE, SYSTEM]

    Preferred OTP delivery type (SMS, EMAIL or VOICE) or SYSTEM to use the system defined default.

    preferredOtpDeliveryContactAttributes

    object

    Preferred OTP delivery contact attribute for the given type (i.e., OTP_EMAIL, OTP_SMS, OTP_VOICE. An empty string means no override for that type).

    property name* string

    Preferred OTP delivery contact attribute for the given type (i.e., OTP_EMAIL, OTP_SMS, OTP_VOICE. An empty string means no override for that type).

    registrationRequired boolean

    Indicates whether self-registration is required. If not set when the user is created, this value defaults to true.

    securityId string

    The security ID of this user. The security ID is a unique value used to identity the user when performing smart card login to Microsoft Windows.

    state string

    Possible values: [ACTIVE, INACTIVE]

    The state of this user. Only users in the ACTIVE state can perform authentication. If not set when the user is created, this value defaults to ACTIVE.

    userAliases

    object[]

    A list of user aliases for this user. Alias values must be unique with respect to the userId and other aliases of this user and other users.

  • Array [

    • id string

    The UUID of this user alias set when the user alias is created.

    type string

    Possible values: [CUSTOM, DERIVED, USERID]

    The type of user alias. A value of USERID is used for an alias that will represent the actual user id value. A value of CUSTOM is used for aliases manually created by an administrator. A value of DERIVED is defined for future use and should not be used at this time.

    userId string

    The UUID of the user to which this user alias belongs.

    value string

    The value for the user alias.

  • ]

    • userAttributeValues

    object[]

    A list of user attribute values for this user.

  • Array [

    • editable boolean

    A flag indicating if this user attribute value can be modified.

    id string

    The UUID of this user attribute value set when the user attribute value is created.

    lastUpdate date-time

    The last time the attribute value was updated.

    userAttribute

    object

    Information about user attribute definitions.

    id string

    The UUID for this user attribute. Generated when the user attribute is created.

    mandatory booleanrequired

    A flag indicating if users must have a value for this user attribute.

    name stringrequired

    The name of this user attribute.

    systemDefined booleanrequired

    A flag indicating if this user attribute is one of the system defined user attributes.

    type string

    Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

    Type of user attribute. Currently only used to specify the type of contact if the attribute is to be used for OTP delivery.

    unique booleanrequired

    A flag indicating if this attribute is intended to be unique.

    userAttributeId string

    The UUID of the user attribute that defines this user attribute value. The userAttributeId must be provided when creating or modifying a user attribute value.

    userId string

    The UUID of the user to which this user attribute value belongs.

    value string

    The value for the user attribute.

  • ]

    • userExtraAttributes

    object[]

    A list of extra optional attributes for this user.

  • Array [

    • name string

    The name for the extra user attribute.

    type string

    Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

    Type of custom user attribute.

    value string

    The value for the extra user attribute.

  • ]

    • userId string

    The user ID for this user. This value is required when creating the user, optional during update. The userId must be unique with respect to aliases of this user and the userId and aliases of all other users.

    userPrincipalName string

    The user principal name of this user. This value may or may not be required depending on configuration. If it is required, it must be specified when creating the user. If it is required, it must be specified when updating the user and a value is not currently set. To remove the existing value, set the value to an empty string.

    verificationRequired boolean

    Indicates whether verification is required. If not set when the user is created, this value defaults to true.

Responses​

Successful

Loading...