Cloud Administration Create Local User API
Last Modified: 2026-11-12

Cloud Administration Create Local User API

Use the Cloud Administration Create Local User API to add a new user account to a local identity source. With this API, you can create a user and set their username and password. You need the "rsa.group.users.manage" OAuth permission to use this endpoint.

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.

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 create a local user.

MethodRequest URLResponse Codes
POST/AdminInterface/restapi/v1/users/create200, 400, 403

 

Request Parameter

The following table describes the request body parameter.

Request ParameterDescriptionData Type
customerIdUnique customer identifierLong

 

Example Request Body

The following is an example request body.

{
    "id": "",
    "firstName": "SampleUser1",
    "lastName": "SampleLname1",
    "userName": "SampleUser1",
    "email": "SampleUser1@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"]
}

You can include additional attributes in the request body, but the API uses them only when Enable Common User Schema Attributes is enabled. This setting is disabled by default. When it is enabled, the API processes and validates them in requests, and returns them in responses. For information about enabling the setting, see the Common User Schema Attributes section in Identity Sources for Cloud Access Service.

The following example request body creates a local user and sets additional common user schema attributes.

{
    "id": "",
    "firstName": "SampleUser1",
    "lastName": "SampleLname1",
    "userName": "SampleUser1",
    "email": "SampleUser1@rsavia.com",
    "identitySource": "Local Identity Source",
    "defaultSmsPhone": "1234567891",
    "defaultVoicePhone": "1234567891",
    "managerEmail": "testManager@rsavia.com",
    "password": null,
    "passwordCreationOption": "NONE",
    "passwordSendMethod": "NONE",
    "initialPasswordEmail": "",
    "alternateUsernames": [
        "group1",
        "group2"
    ],
    "groupMemberships": [
        "group1",
        "group2"
    ],
    "smsPhoneNumbers": [
        "1234567892",
        "1234567893"
    ],
    "voicePhoneNumbers": [
        "1234567892",
        "1234567893"
    ],
    "businessCategory": "Sample Business Category",
    "companyOrOrganization": "Sample Company",
    "department": "Sample Department",
    "countryCode": "+1",
    "description": "Software Engineer",
    "displayName": "SampleUser1",
    "employeeNumber": "EMP001",
    "employeeType": "Full-Time",
    "homeEmail": "username3@personal.com",
    "mobile": "+1234567892",
    "workPhone": "+0987654322",
    "fullName": "sample fullName"
}

Request Properties

The following table explains the request properties.

FieldDescriptionRequired
First nameUser's first name.Yes
User nameUnique username.Yes
EmailUser's email address.Yes
IdentitySourceSource of user identity (for example, local or LDAP).Yes
PasswordCreationOptionSpecifies how the user's password is set. Options are "NONE", "GENERATE_AND_SEND", and "ENTERED_BY_ADMIN".Yes
passwordSendMethodSpecifies how the system delivers the generated password to the user. Options are "NONE" and "EMAIL".Required only if passwordCreationOption is set to "GENERATE_AND_SEND"
businessCategoryDescriptive text about an organizational unit the user is associated with.No
companyOrOrganizationName of the company or organization the user belongs to.No
countryCodeTwo-letter country code for the user.No
departmentDepartment the user belongs to.No
descriptionDescriptive text about the user.No
displayNameName shown for the user. This may be the full name or a nickname set by the user or an administrator.No
employeeNumberNumeric or alphanumeric identifier assigned to the person.No
employeeTypeJob category of the employee.No
fullNameUser's full name.No
homeEmailAdditional mail addresses associated with the user.No
mobileUser's mobile phone number.No
workPhoneUser's work telephone number.No

Example Response

The following is an example response.

{
    "cloud_directory_enabled": true,
    "user_id": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
    "email": "SampleUser1@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": [],
}

When Enable Common User Schema Attributes is enabled, the response includes the additional common schema attributes. The following example response confirms that the local user and the additional Common User Schema attributes were created successfully.

{
    "cloud_directory_enabled": false,
    "user_id": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
    "email": "SampleUser1@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": [],
    "business_category_valid": true,
    "company_or_organization_valid": true,
    "country_code_valid": true,
    "full_name_valid": true,
    "department_valid": true,
    "description_valid": true,
    "display_name_valid": true,
    "employee_number_valid": true,
    "employee_type_valid": true,
    "home_email_valid": true,
    "mobile_valid": true,
    "work_phone_valid": true
}

Response Codes

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

CodeDescription
200

A request to create a user has been submitted successfully. The saveSucceeded variable in the UserUpdateStatusPublicDTO will indicate whether the user was created successfully.

400

The operation could not be completed. One of the following error messages may be returned:

  • Password creation option is required to create a user.

  • Generate and Display password creation option is not supported by this API.

  • Password usage is not allowed for this identity source.

  • Password is required for users in this identity source.

  • Email notification must be configured before generating and sending the initial password.

  • An identity source is required to create users.

  • A local identity source is required to create users.

  • User creation requests are not allowed for identity source type {IS_Type}.

403Not authorized to perform the request. The request includes incorrect OAuth permissions.