Skip to main content

User schema by ID​

Returns the user schema identified by the requested ID.

Path Parameters
    id string required

    unique identifier of the schema.

Responses

Schema successfully retrieved


Schema
    schema object
    id string

    ID is the read-only unique identifier of the 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
    type string

    Type is a human readable text describing the schema.

    state string

    Possible values: [STATE_UNSPECIFIED, STATE_ACTIVE, STATE_INACTIVE]

    Default value: STATE_UNSPECIFIED

    Current state of the schema.

    revision int64

    Revision is a read only version of the schema, each update of the schema-field increases the revision.

    schema object

    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. This allows creating different user types like human/machine without usage of actions to validate possible authenticators. Removal of an authenticator does not remove the authenticator on a user.

Loading...