com.io7m.idstore.protocol.user.cb
Types
- IdU1CommandEmailAddBegin
- IdU1CommandEmailAddDeny
- IdU1CommandEmailAddPermit
- IdU1CommandEmailRemoveBegin
- IdU1CommandEmailRemoveDeny
- IdU1CommandEmailRemovePermit
- IdU1CommandLogin
- IdU1CommandPasswordUpdate
- IdU1CommandRealnameUpdate
- IdU1CommandUserSelf
- IdU1Password
- IdU1ResponseBlame
- IdU1ResponseEmailAddBegin
- IdU1ResponseEmailAddDeny
- IdU1ResponseEmailAddPermit
- IdU1ResponseEmailRemoveBegin
- IdU1ResponseEmailRemoveDeny
- IdU1ResponseEmailRemovePermit
- IdU1ResponseError
- IdU1ResponseLogin
- IdU1ResponseUserSelf
- IdU1ResponseUserUpdate
- IdU1TimestampUTC
- IdU1User
IdU1CommandEmailAddBegin
A request to add an email address.
[record IdU1CommandEmailAddBegin [field email String] ]
Fields
Name | Type | Description |
---|---|---|
String | The email address. |
IdU1CommandEmailAddDeny
A request to complete an email address challenge.
[record IdU1CommandEmailAddDeny [field token String] ]
Fields
Name | Type | Description |
---|---|---|
token | String | The challenge token. |
IdU1CommandEmailAddPermit
A request to complete an email address challenge.
[record IdU1CommandEmailAddPermit [field token String] ]
Fields
Name | Type | Description |
---|---|---|
token | String | The challenge token. |
IdU1CommandEmailRemoveBegin
A request to remove an email address.
[record IdU1CommandEmailRemoveBegin [field email String] ]
Fields
Name | Type | Description |
---|---|---|
String | The email address. |
IdU1CommandEmailRemoveDeny
A request to complete an email address challenge.
[record IdU1CommandEmailRemoveDeny [field token String] ]
Fields
Name | Type | Description |
---|---|---|
token | String | The challenge token. |
IdU1CommandEmailRemovePermit
A request to complete an email address challenge.
[record IdU1CommandEmailRemovePermit [field token String] ]
Fields
Name | Type | Description |
---|---|---|
token | String | The challenge token. |
IdU1CommandLogin
A request to log in.
IdU1CommandPasswordUpdate
A request to update the user's password.
[record IdU1CommandPasswordUpdate [field password String] [field passwordConfirm String] ]
Fields
Name | Type | Description |
---|---|---|
password | String | The new password. |
passwordConfirm | String | The password confirmation. |
IdU1CommandRealnameUpdate
A request to update the user's real name.
[record IdU1CommandRealnameUpdate [field name String] ]
Fields
Name | Type | Description |
---|---|---|
name | String | The new name. |
IdU1CommandUserSelf
A request to fetch the user's own profile.
IdU1Password
Information for a hashed password.
[record IdU1Password [field algorithm String] [field hash String] [field salt String] [field expires [OptionOffsetDateTime]] ]
Fields
Name | Type | Description |
---|---|---|
algorithm | String | The password algorithm. |
hash | String | The password hash. |
salt | String | The password salt. |
expires | [OptionOffsetDateTime] | The password expiration date. |
IdU1ResponseBlame
A blame assignment.
[variant IdU1ResponseBlame [case BlameClient] [case BlameServer] ]
Cases
Case BlameClient
The case BlameClient has no fields.
Case BlameServer
The case BlameServer has no fields.
IdU1ResponseEmailAddBegin
A response to IdU1CommandEmailAddBegin.
[record IdU1ResponseEmailAddBegin [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdU1ResponseEmailAddDeny
A response to IdU1CommandEmailAddDeny.
[record IdU1ResponseEmailAddDeny [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdU1ResponseEmailAddPermit
A response to IdU1CommandEmailAddPermit.
[record IdU1ResponseEmailAddPermit [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdU1ResponseEmailRemoveBegin
A response to IdU1CommandEmailRemoveBegin.
[record IdU1ResponseEmailRemoveBegin [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdU1ResponseEmailRemoveDeny
A response to IdU1CommandEmailRemoveDeny.
[record IdU1ResponseEmailRemoveDeny [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdU1ResponseEmailRemovePermit
A response to IdU1CommandEmailRemovePermit.
[record IdU1ResponseEmailRemovePermit [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdU1ResponseError
An error response.
[record IdU1ResponseError [field requestId UUID] [field errorCode String] [field message String] [field attributes [MapStringString]] [field remediatingAction [OptionString]] [field blame IdU1ResponseBlame] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
errorCode | String | The error code. |
message | String | The error message. |
attributes | [MapStringString] | The error attributes. |
remediatingAction | [OptionString] | The remediating action, if any. |
blame | IdU1ResponseBlame | The blame assignment. |
IdU1ResponseLogin
A response to IdU1CommandLogin.
IdU1ResponseUserSelf
A response to IdU1CommandUserSelf.
IdU1ResponseUserUpdate
A response to various update commands.
IdU1TimestampUTC
A UTC timestamp value.
[record IdU1TimestampUTC [field year IntegerUnsigned32] [field month IntegerUnsigned8] [field day IntegerUnsigned8] [field hour IntegerUnsigned8] [field minute IntegerUnsigned8] [field second IntegerUnsigned8] [field millisecond IntegerUnsigned32] ]
Fields
Name | Type | Description |
---|---|---|
year | IntegerUnsigned32 | The year. |
month | IntegerUnsigned8 | The month in the range [1, 12]. |
day | IntegerUnsigned8 | The day of the month in the range [1, 31]. |
hour | IntegerUnsigned8 | The hour in the range [0, 23]. |
minute | IntegerUnsigned8 | The minute in the range [0, 59]. |
second | IntegerUnsigned8 | The second in the range [0, 59]. |
millisecond | IntegerUnsigned32 | The millisecond in the range [0, 999]. |
IdU1User
A user.
[record IdU1User [field id UUID] [field idName String] [field realName String] [field emails [ListString]] [field timeCreated IdU1TimestampUTC] [field timeUpdated IdU1TimestampUTC] [field password IdU1Password] ]
Fields
Name | Type | Description |
---|---|---|
id | UUID | The user ID. |
idName | String | The user ID name. |
realName | String | The user real name. |
emails | [ListString] | The user emails. |
timeCreated | IdU1TimestampUTC | The time the account was created. |
timeUpdated | IdU1TimestampUTC | The time the account was updated. |
password | IdU1Password | The user password. |
IdU
Protocol identifier: f5ff6a1f-d96b-3e33-8146-ed7b8164c282
The User protocol.
Version 1 Messages
Name | Description |
---|---|
IdU1CommandEmailAddBegin | A request to add an email address. |
IdU1CommandEmailAddDeny | A request to complete an email address challenge. |
IdU1CommandEmailAddPermit | A request to complete an email address challenge. |
IdU1CommandEmailRemoveBegin | A request to remove an email address. |
IdU1CommandEmailRemoveDeny | A request to complete an email address challenge. |
IdU1CommandEmailRemovePermit | A request to complete an email address challenge. |
IdU1CommandLogin | A request to log in. |
IdU1CommandPasswordUpdate | A request to update the user's password. |
IdU1CommandRealnameUpdate | A request to update the user's real name. |
IdU1CommandUserSelf | A request to fetch the user's own profile. |
IdU1ResponseEmailAddBegin | A response to IdU1CommandEmailAddBegin. |
IdU1ResponseEmailAddDeny | A response to IdU1CommandEmailAddDeny. |
IdU1ResponseEmailAddPermit | A response to IdU1CommandEmailAddPermit. |
IdU1ResponseEmailRemoveBegin | A response to IdU1CommandEmailRemoveBegin. |
IdU1ResponseEmailRemoveDeny | A response to IdU1CommandEmailRemoveDeny. |
IdU1ResponseEmailRemovePermit | A response to IdU1CommandEmailRemovePermit. |
IdU1ResponseError | An error response. |
IdU1ResponseLogin | A response to IdU1CommandLogin. |
IdU1ResponseUserSelf | A response to IdU1CommandUserSelf. |
IdU1ResponseUserUpdate | A response to various update commands. |