• Users
• Update user details

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

Scopes

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

• identity.krystal.io/api/v1/user:update

Arguments

The following arguments are supported for this endpoint.

Potential Errors

The following errors may occur during this request.

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? ]
        roles_details: [ Role? {
            name: String
            label: String
            description: String?
            require_two_factor_auth: Boolean
            organization_id: String?
        } ]
        role_permissions: [ String? ]
        identity_check_state: IdentityCheckStateEnum
        identity_check_verified_at: Unix Timestamp?
        organizations: [ OrganizationUser {
            user_id: String
            organization_id: String
            organization_name: String
            organization_identifier: String
            organization_managed: Boolean
            organization_parent_id: String?
            owner: Boolean
            organization_updated_at: Unix Timestamp
            roles: [ String? ]
        } ]
    }
}