Cloud Administration Update Local User API

Use the Cloud Administration Update Local User API to modify existing user accounts in a local identity source. This API allows you to update user details such as name, email address, and password.

For more information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

This API is accessible only via OAuth and does not support the legacy JSON Web Token (JWT) authentication flow. For more information, see Manage OAuth API Clients.

You need the "rsa.group.users.manage" OAuth permission to use this endpoint.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to perform a local user update request.

Request Parameter

The following table describes the request body parameter.

Example Request Body

The following is an example request body.

{
    "id": "b60ee604-1c1a-4160-94cd-da5442c819bd",
    "firstName": "Joe",
    "lastName": "Schmoe",
    "userName": "jschmoe",
    "email": "jschmoe@rsavia.com",
    "defaultSmsPhone": "1234567890",
    "defaultVoicePhone": "1234567890",
    "managerEmail": "testManager@rsavia.com",
    "identitySource": "Local Identity Source",
    "password": null,
    "passwordCreationOption": "NONE",
    "passwordSendMethod": "NONE",
    "initialPasswordEmail": "",
    "alternateUsernames": ["group1", "group2"],
    "groupMemberships": ["group1", "group2"],
    "smsPhoneNumbers": ["1234567891", "1234567892"],
    "voicePhoneNumbers": ["1234567891", "1234567892"]
}

Example Request Data

The following is an example request data.

PUT /AdminInterface/restapi/v1/users/update

createContent-Type: application/json

Authorization: Bearer <Oauth token>

Request Properties Descriptions

The following table explains the request properties.

Example Response

The following example shows the example return response.

{
    "cloud_directory_enabled": true,
    "user_id": "80800c5b-707b-3cd4-de78-48e67e4a923d",
    "email": "jschmoe@rsavia.com",
    "first_name_valid": true,
    "last_name_valid": true
    "username_valid": true,
    "email_valid": true,
    "email_failure_reason": null,
    "sms_phone_valid": true,
    "voice_phone_valid": true,
    "manager_email_valid": true,
    "manager_email_failure_reason": null,
    "identity_source_valid": true,
    "password_valid": true,
    "initial_password_email_valid": false,
    "password_send_method_valid": true,
    "alternate_username_valid": [true, true],
    "virtualgroups_valid": [true, true],
    "sms_phone_list_valid": [true, true],
    "voice_phone_list_valid": [true, true],
    "save_succeeded": true,
    "save_failure_reason": null,
    "duplicate_username": false,
    "validation_errors": [],
}

Response Codes

The following table lists the response codes and their descriptions for this API.