Skip to main content

User schema by ID

GET 
/resources/v3alpha/user_schemas/:id

Returns the user schema identified by the requested ID.

Request​

Path Parameters

    id stringrequired

    unique identifier of the schema.

Responses​

Schema successfully retrieved

Schema

    userSchema

    object

    details

    object

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

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string

    config

    object

    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.

    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.

Loading...