Create a user schema​
Create the first revision of a new user schema. The schema can then be used on users to store and validate their data.
Request Body required
Possible values: non-empty
and <= 200 characters
Type is a human readable word describing the schema.
JSON schema representation defining the user.
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.
Request Body required
Possible values: non-empty
and <= 200 characters
Type is a human readable word describing the schema.
JSON schema representation defining the user.
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.
Request Body required
Possible values: non-empty
and <= 200 characters
Type is a human readable word describing the schema.
JSON schema representation defining the user.
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.
- 200
- 201
- 403
- 404
- default
A successful response.
Schema
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.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.990Z",
"resourceOwner": "69629023906488334"
}
}
Schema
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.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.990Z",
"resourceOwner": "69629023906488334"
}
}
Schema
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.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.991Z",
"resourceOwner": "69629023906488334"
}
}
Schema successfully created
Schema
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.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.991Z",
"resourceOwner": "69629023906488334"
}
}
Schema
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.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.991Z",
"resourceOwner": "69629023906488334"
}
}
Schema
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.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"id": "string",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.991Z",
"resourceOwner": "69629023906488334"
}
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}