User schema by ID​
Returns the user schema identified by the requested ID.
Path Parameters
unique identifier of the schema.
- 200
- 403
- 404
- default
Schema successfully retrieved
Schema
schema object
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
Type is a human readable text describing the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Current state of the schema.
Revision is a read only version of the schema, each update of the schema
-field increases the revision.
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. 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.
{
"schema": {
"id": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.984Z",
"resourceOwner": "69629023906488334"
},
"type": "employees",
"state": "STATE_ACTIVE",
"revision": "2",
"schema": {
"$schema": "https://example.com/user/employees",
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
}
}
},
"possibleAuthenticators": [
"AUTHENTICATOR_TYPE_USERNAME",
"AUTHENTICATOR_TYPE_PASSWORD",
"AUTHENTICATOR_TYPE_WEBAUTHN"
]
}
}
Schema
schema object
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
Type is a human readable text describing the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Current state of the schema.
Revision is a read only version of the schema, each update of the schema
-field increases the revision.
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. 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.
{
"schema": {
"id": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.984Z",
"resourceOwner": "69629023906488334"
},
"type": "employees",
"state": "STATE_ACTIVE",
"revision": "2",
"schema": {
"$schema": "https://example.com/user/employees",
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
}
}
},
"possibleAuthenticators": [
"AUTHENTICATOR_TYPE_USERNAME",
"AUTHENTICATOR_TYPE_PASSWORD",
"AUTHENTICATOR_TYPE_WEBAUTHN"
]
}
}
Schema
schema object
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
Type is a human readable text describing the schema.
Possible values: [STATE_UNSPECIFIED
, STATE_ACTIVE
, STATE_INACTIVE
]
Default value: STATE_UNSPECIFIED
Current state of the schema.
Revision is a read only version of the schema, each update of the schema
-field increases the revision.
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. 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.
{
"schema": {
"id": "69629012906488334",
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:35.984Z",
"resourceOwner": "69629023906488334"
},
"type": "employees",
"state": "STATE_ACTIVE",
"revision": "2",
"schema": {
"$schema": "https://example.com/user/employees",
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
}
}
},
"possibleAuthenticators": [
"AUTHENTICATOR_TYPE_USERNAME",
"AUTHENTICATOR_TYPE_PASSWORD",
"AUTHENTICATOR_TYPE_WEBAUTHN"
]
}
}
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"
}
]
}