Skip to main content

Update a user schema

PUT 
/v3alpha/user_schemas/:id

Update an existing user schema to a new revision. Users based on the current revision will not be affected until they are updated.

Request​

Path Parameters

    id stringrequired

    unique identifier of the schema.

Body

required

    type stringrequired

    Possible values: non-empty and <= 200 characters

    Type is a human readable word describing the schema.

    schema objectrequired

    JSON schema representation defining the user.

    possibleAuthenticators string[]

    Possible values: [AUTHENTICATOR_TYPE_UNSPECIFIED, AUTHENTICATOR_TYPE_USERNAME, AUTHENTICATOR_TYPE_PASSWORD, AUTHENTICATOR_TYPE_WEBAUTHN, AUTHENTICATOR_TYPE_TOTP, AUTHENTICATOR_TYPE_OTP_EMAIL, AUTHENTICATOR_TYPE_OTP_SMS, AUTHENTICATOR_TYPE_AUTHENTICATION_KEY, AUTHENTICATOR_TYPE_IDENTITY_PROVIDER]

    Defines the possible types of authenticators.

    Removal of an authenticator does not remove the authenticator on a user.

Responses​

Schema successfully updated

Schema

    details

    object

    Details provide some base information (such as the last change date) of the schema.

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
Loading...