Update a user

put

https://{hostname}/amfa/v1/users/{userId}

Modify a user's basic information. To add an alias or assign a group to a user, run the Add an alias to a user and Assign groups operations.

Path Params

userId

string

required

A unique identifier for the user account.

Query Params

contractId

string

required

Unique identifier for the contract.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Update user request JSON.

string

required

length ≥ 1

The user's email address.

firstName

string

required

length ≥ 1

The user's first name.

lastName

string

required

length ≥ 1

The user's last name.

username

string

required

length ≥ 1

The user's username. The username is unique for the tenant.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200The response provides data for a single user.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

500Internal server error.