API Reference

Krystal Identity API

Resources & Endpoints

Update user details

Allows for updating of basic user details.

PATCH
https://identity.krystal.io/api/v1/user

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

properties Required

UserUpdateProperties None

Potential Errors

The following errors may occur during this request.

Details HTTP status

validation_error

An error ocurred with the input provided

 422 Unprocessable Entity

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    user: User {
        id: String
        name: String
        first_name: String
        last_name: String
        time_zone: String
        two_factor_auth_enabled: Boolean
        email_address: String?
        email_addresses: [ String? ]
        roles: [ String ]
        identity_check_state: IdentityCheckStateEnum
        identity_check_verified_at: Unix Timestamp?
    }
}