com.io7m.idstore.protocol.admin.cb
Types
- IdA1Admin
- IdA1AdminColumn
- IdA1AdminColumnOrdering
- IdA1AdminPermission
- IdA1AdminSearchByEmailParameters
- IdA1AdminSearchParameters
- IdA1AdminSummary
- IdA1AuditEvent
- IdA1AuditSearchParameters
- IdA1Ban
- IdA1CommandAdminBanCreate
- IdA1CommandAdminBanDelete
- IdA1CommandAdminBanGet
- IdA1CommandAdminCreate
- IdA1CommandAdminDelete
- IdA1CommandAdminEmailAdd
- IdA1CommandAdminEmailRemove
- IdA1CommandAdminGet
- IdA1CommandAdminGetByEmail
- IdA1CommandAdminPermissionGrant
- IdA1CommandAdminPermissionRevoke
- IdA1CommandAdminSearchBegin
- IdA1CommandAdminSearchByEmailBegin
- IdA1CommandAdminSearchByEmailNext
- IdA1CommandAdminSearchByEmailPrevious
- IdA1CommandAdminSearchNext
- IdA1CommandAdminSearchPrevious
- IdA1CommandAdminSelf
- IdA1CommandAdminUpdateCredentials
- IdA1CommandAdminUpdatePasswordExpiration
- IdA1CommandAuditSearchBegin
- IdA1CommandAuditSearchNext
- IdA1CommandAuditSearchPrevious
- IdA1CommandLogin
- IdA1CommandMailTest
- IdA1CommandMaintenanceModeSet
- IdA1CommandUserBanCreate
- IdA1CommandUserBanDelete
- IdA1CommandUserBanGet
- IdA1CommandUserCreate
- IdA1CommandUserDelete
- IdA1CommandUserEmailAdd
- IdA1CommandUserEmailRemove
- IdA1CommandUserGet
- IdA1CommandUserGetByEmail
- IdA1CommandUserLoginHistory
- IdA1CommandUserSearchBegin
- IdA1CommandUserSearchByEmailBegin
- IdA1CommandUserSearchByEmailNext
- IdA1CommandUserSearchByEmailPrevious
- IdA1CommandUserSearchNext
- IdA1CommandUserSearchPrevious
- IdA1CommandUserUpdateCredentials
- IdA1CommandUserUpdatePasswordExpiration
- IdA1Login
- IdA1Page
- IdA1Password
- IdA1PasswordExpirationSet
- IdA1ResponseAdminBanCreate
- IdA1ResponseAdminBanDelete
- IdA1ResponseAdminBanGet
- IdA1ResponseAdminCreate
- IdA1ResponseAdminDelete
- IdA1ResponseAdminGet
- IdA1ResponseAdminSearchBegin
- IdA1ResponseAdminSearchByEmailBegin
- IdA1ResponseAdminSearchByEmailNext
- IdA1ResponseAdminSearchByEmailPrevious
- IdA1ResponseAdminSearchNext
- IdA1ResponseAdminSearchPrevious
- IdA1ResponseAdminSelf
- IdA1ResponseAdminUpdate
- IdA1ResponseAuditSearchBegin
- IdA1ResponseAuditSearchNext
- IdA1ResponseAuditSearchPrevious
- IdA1ResponseBlame
- IdA1ResponseError
- IdA1ResponseLogin
- IdA1ResponseMailTest
- IdA1ResponseMaintenanceModeSet
- IdA1ResponseUserBanCreate
- IdA1ResponseUserBanDelete
- IdA1ResponseUserBanGet
- IdA1ResponseUserCreate
- IdA1ResponseUserDelete
- IdA1ResponseUserGet
- IdA1ResponseUserLoginHistory
- IdA1ResponseUserSearchBegin
- IdA1ResponseUserSearchByEmailBegin
- IdA1ResponseUserSearchByEmailNext
- IdA1ResponseUserSearchByEmailPrevious
- IdA1ResponseUserSearchNext
- IdA1ResponseUserSearchPrevious
- IdA1ResponseUserUpdate
- IdA1TimeRange
- IdA1TimestampUTC
- IdA1User
- IdA1UserColumn
- IdA1UserColumnOrdering
- IdA1UserSearchByEmailParameters
- IdA1UserSearchParameters
- IdA1UserSummary
IdA1Admin
An administrator.
[record IdA1Admin [field id UUID] [field idName String] [field realName String] [field emails [ListString]] [field timeCreated IdA1TimestampUTC] [field timeUpdated IdA1TimestampUTC] [field password IdA1Password] [field permissions [ListIdA1AdminPermission]] ]
Fields
Name | Type | Description |
---|---|---|
id | UUID | The admin ID. |
idName | String | The admin ID name. |
realName | String | The admin real name. |
emails | [ListString] | The admin emails. |
timeCreated | IdA1TimestampUTC | The time the admin was created. |
timeUpdated | IdA1TimestampUTC | The time the admin was last updated. |
password | IdA1Password | The hashed admin password. |
permissions | [ListIdA1AdminPermission] | The admin permissions. |
IdA1AdminColumn
A column to use for sorting admins.
[variant IdA1AdminColumn [case ByID] [case ByIDName] [case ByRealName] [case ByTimeCreated] [case ByTimeUpdated] ]
Cases
Case ByID
The case ByID has no fields.
Case ByIDName
The case ByIDName has no fields.
Case ByRealName
The case ByRealName has no fields.
Case ByTimeCreated
The case ByTimeCreated has no fields.
Case ByTimeUpdated
The case ByTimeUpdated has no fields.
IdA1AdminColumnOrdering
A column ordering spec.
[record IdA1AdminColumnOrdering [field column IdA1AdminColumn] [field ascending Boolean] ]
Fields
Name | Type | Description |
---|---|---|
column | IdA1AdminColumn | The admin column. |
ascending | Boolean | True if the results should be ascending. |
IdA1AdminPermission
An admin permission.
[variant IdA1AdminPermission [case AdminBan] [case AdminCreate] [case AdminDelete] [case AdminWriteCredentials] [case AdminWriteCredentialsSelf] [case AdminWriteEmail] [case AdminWriteEmailSelf] [case AdminWritePermissions] [case AdminWritePermissionsSelf] [case AdminRead] [case AuditRead] [case UserDelete] [case UserCreate] [case UserWriteCredentials] [case UserWriteEmail] [case UserRead] [case UserBan] [case MailTest] [case MaintenanceMode] ]
Cases
Case AdminBan
The case AdminBan has no fields.
Case AdminCreate
The case AdminCreate has no fields.
Case AdminDelete
The case AdminDelete has no fields.
Case AdminWriteCredentials
The case AdminWriteCredentials has no fields.
Case AdminWriteCredentialsSelf
The case AdminWriteCredentialsSelf has no fields.
Case AdminWriteEmail
The case AdminWriteEmail has no fields.
Case AdminWriteEmailSelf
The case AdminWriteEmailSelf has no fields.
Case AdminWritePermissions
The case AdminWritePermissions has no fields.
Case AdminWritePermissionsSelf
The case AdminWritePermissionsSelf has no fields.
Case AdminRead
The case AdminRead has no fields.
Case AuditRead
The case AuditRead has no fields.
Case UserDelete
The case UserDelete has no fields.
Case UserCreate
The case UserCreate has no fields.
Case UserWriteCredentials
The case UserWriteCredentials has no fields.
Case UserWriteEmail
The case UserWriteEmail has no fields.
Case UserRead
The case UserRead has no fields.
Case UserBan
The case UserBan has no fields.
Case MailTest
The case MailTest has no fields.
Case MaintenanceMode
The case MaintenanceMode has no fields.
IdA1AdminSearchByEmailParameters
Search parameters for admins (by email).
[record IdA1AdminSearchByEmailParameters [field timeCreatedRange IdA1TimeRange] [field timeUpdatedRange IdA1TimeRange] [field search String] [field ordering IdA1AdminColumnOrdering] [field limit IntegerUnsigned16] ]
Fields
Name | Type | Description |
---|---|---|
timeCreatedRange | IdA1TimeRange | The range of creation times for returned admins. |
timeUpdatedRange | IdA1TimeRange | The range of update times for returned admins. |
search | String | The search query text. |
ordering | IdA1AdminColumnOrdering | The result ordering. |
limit | IntegerUnsigned16 | The limit on the number of results. |
IdA1AdminSearchParameters
Search parameters for admins.
[record IdA1AdminSearchParameters [field timeCreatedRange IdA1TimeRange] [field timeUpdatedRange IdA1TimeRange] [field search [OptionString]] [field ordering IdA1AdminColumnOrdering] [field limit IntegerUnsigned16] ]
Fields
Name | Type | Description |
---|---|---|
timeCreatedRange | IdA1TimeRange | The range of creation times for returned admins. |
timeUpdatedRange | IdA1TimeRange | The range of update times for returned admins. |
search | [OptionString] | The search query text. |
ordering | IdA1AdminColumnOrdering | The result ordering. |
limit | IntegerUnsigned16 | The limit on the number of results. |
IdA1AdminSummary
An admin summary.
[record IdA1AdminSummary [field id UUID] [field idName String] [field realName String] [field timeCreated IdA1TimestampUTC] [field timeUpdated IdA1TimestampUTC] ]
Fields
Name | Type | Description |
---|---|---|
id | UUID | The admin ID. |
idName | String | The admin ID name. |
realName | String | The admin real name. |
timeCreated | IdA1TimestampUTC | The time the admin was created. |
timeUpdated | IdA1TimestampUTC | The time the admin was last updated. |
IdA1AuditEvent
An audit event.
[record IdA1AuditEvent [field id IntegerUnsigned64] [field owner UUID] [field time IdA1TimestampUTC] [field type String] [field data [MapStringString]] ]
Fields
Name | Type | Description |
---|---|---|
id | IntegerUnsigned64 | The audit event ID. |
owner | UUID | The audit event owner. |
time | IdA1TimestampUTC | The audit event time. |
type | String | The audit event type. |
data | [MapStringString] | The audit event data. |
IdA1AuditSearchParameters
Search parameters for audit records.
[record IdA1AuditSearchParameters [field timeRange IdA1TimeRange] [field owner [OptionString]] [field type [OptionString]] [field limit IntegerUnsigned16] ]
Fields
Name | Type | Description |
---|---|---|
timeRange | IdA1TimeRange | The range of time to include. |
owner | [OptionString] | All records contain this owner, if specified. |
type | [OptionString] | All records contain this type, if specified. |
limit | IntegerUnsigned16 | The limit on the number of results. |
IdA1Ban
An account ban.
IdA1CommandAdminBanCreate
Ban an admin.
IdA1CommandAdminBanDelete
Remove a ban on an admin.
[record IdA1CommandAdminBanDelete [field adminId UUID] ]
Fields
Name | Type | Description |
---|---|---|
adminId | UUID | The admin. |
IdA1CommandAdminBanGet
Get a ban on an admin.
[record IdA1CommandAdminBanGet [field adminId UUID] ]
Fields
Name | Type | Description |
---|---|---|
adminId | UUID | The admin. |
IdA1CommandAdminCreate
Create an admin.
[record IdA1CommandAdminCreate [field adminId [OptionUUID]] [field idName String] [field realName String] [field email String] [field password IdA1Password] [field permissions [ListIdA1AdminPermission]] ]
Fields
Name | Type | Description |
---|---|---|
adminId | [OptionUUID] | The admin. |
idName | String | The admin ID name. |
realName | String | The admin real name. |
String | The admin email. | |
password | IdA1Password | The admin password. |
permissions | [ListIdA1AdminPermission] | The set of permissions. |
IdA1CommandAdminDelete
Delete an admin.
[record IdA1CommandAdminDelete [field adminId UUID] ]
Fields
Name | Type | Description |
---|---|---|
adminId | UUID | The admin. |
IdA1CommandAdminEmailAdd
Add an email address to the given admin.
IdA1CommandAdminEmailRemove
Remove an email address from the given admin.
IdA1CommandAdminGet
Get the given admin.
IdA1CommandAdminGetByEmail
Get the admin with the given email address.
[record IdA1CommandAdminGetByEmail [field email String] ]
Fields
Name | Type | Description |
---|---|---|
String | The email address. |
IdA1CommandAdminPermissionGrant
Grant a permission to the given admin.
[record IdA1CommandAdminPermissionGrant [field adminId UUID] [field permission IdA1AdminPermission] ]
Fields
Name | Type | Description |
---|---|---|
adminId | UUID | The admin. |
permission | IdA1AdminPermission | The permission. |
IdA1CommandAdminPermissionRevoke
Revoke a permission from the given admin.
[record IdA1CommandAdminPermissionRevoke [field adminId UUID] [field permission IdA1AdminPermission] ]
Fields
Name | Type | Description |
---|---|---|
adminId | UUID | The admin. |
permission | IdA1AdminPermission | The permission. |
IdA1CommandAdminSearchBegin
Start searching for admins.
[record IdA1CommandAdminSearchBegin [field parameters IdA1AdminSearchParameters] ]
Fields
Name | Type | Description |
---|---|---|
parameters | IdA1AdminSearchParameters | The search parameters. |
IdA1CommandAdminSearchByEmailBegin
Start searching for admins (by email).
[record IdA1CommandAdminSearchByEmailBegin [field parameters IdA1AdminSearchByEmailParameters] ]
Fields
Name | Type | Description |
---|---|---|
parameters | IdA1AdminSearchByEmailParameters | The search parameters. |
IdA1CommandAdminSearchByEmailNext
Get the next page of admin search results.
IdA1CommandAdminSearchByEmailPrevious
Get the previous page of admin search results.
IdA1CommandAdminSearchNext
Get the next page of admin search results.
IdA1CommandAdminSearchPrevious
Get the previous page of admin search results.
IdA1CommandAdminSelf
A request to fetch the admin's own profile.
IdA1CommandAdminUpdateCredentials
A request to edit an admin's credentials.
[record IdA1CommandAdminUpdateCredentials [field adminId UUID] [field idName [OptionString]] [field realName [OptionString]] [field password [OptionIdA1Password]] ]
Fields
Name | Type | Description |
---|---|---|
adminId | UUID | The admin. |
idName | [OptionString] | The admin's new ID name. |
realName | [OptionString] | The admin's new real name. |
password | [OptionIdA1Password] | The admin's new password |
IdA1CommandAdminUpdatePasswordExpiration
A request to update the admin's password expiration.
[record IdA1CommandAdminUpdatePasswordExpiration [field userId UUID] [field set IdA1PasswordExpirationSet] ]
Fields
Name | Type | Description |
---|---|---|
userId | UUID | The admin. |
set | IdA1PasswordExpirationSet | The set behaviour. |
IdA1CommandAuditSearchBegin
Start searching/listing audit records.
[record IdA1CommandAuditSearchBegin [field parameters IdA1AuditSearchParameters] ]
Fields
Name | Type | Description |
---|---|---|
parameters | IdA1AuditSearchParameters | The search parameters. |
IdA1CommandAuditSearchNext
Get the next page of audit search results.
IdA1CommandAuditSearchPrevious
Get the previous page of audit search results.
IdA1CommandLogin
A request to log in.
IdA1CommandMailTest
Send a test email to a given address.
IdA1CommandMaintenanceModeSet
Move the server to/from maintenance mode.
IdA1CommandUserBanCreate
Ban a user.
IdA1CommandUserBanDelete
Remove a ban on a user.
IdA1CommandUserBanGet
Get a ban on a user.
IdA1CommandUserCreate
Create a user.
[record IdA1CommandUserCreate [field userId [OptionUUID]] [field idName String] [field realName String] [field email String] [field password IdA1Password] ]
Fields
Name | Type | Description |
---|---|---|
userId | [OptionUUID] | The user. |
idName | String | The user ID name. |
realName | String | The user real name. |
String | The user email. | |
password | IdA1Password | The user password. |
IdA1CommandUserDelete
Delete a user.
IdA1CommandUserEmailAdd
Add an email address to the given user.
IdA1CommandUserEmailRemove
Remove an email address from the given user.
IdA1CommandUserGet
Get the given user.
IdA1CommandUserGetByEmail
Get the user with the given email address.
[record IdA1CommandUserGetByEmail [field email String] ]
Fields
Name | Type | Description |
---|---|---|
String | The email address. |
IdA1CommandUserLoginHistory
Get the given user's login history.
[record IdA1CommandUserLoginHistory [field userId UUID] ]
Fields
Name | Type | Description |
---|---|---|
userId | UUID | The user. |
IdA1CommandUserSearchBegin
Start searching for users.
[record IdA1CommandUserSearchBegin [field parameters IdA1UserSearchParameters] ]
Fields
Name | Type | Description |
---|---|---|
parameters | IdA1UserSearchParameters | The search parameters. |
IdA1CommandUserSearchByEmailBegin
Start searching for users (by email).
[record IdA1CommandUserSearchByEmailBegin [field parameters IdA1UserSearchByEmailParameters] ]
Fields
Name | Type | Description |
---|---|---|
parameters | IdA1UserSearchByEmailParameters | The search parameters. |
IdA1CommandUserSearchByEmailNext
Get the next page of user search results.
IdA1CommandUserSearchByEmailPrevious
Get the previous page of user search results.
IdA1CommandUserSearchNext
Get the next page of user search results.
IdA1CommandUserSearchPrevious
Get the previous page of user search results.
IdA1CommandUserUpdateCredentials
A request to fetch the user's own profile.
[record IdA1CommandUserUpdateCredentials [field userId UUID] [field idName [OptionString]] [field realName [OptionString]] [field password [OptionIdA1Password]] ]
Fields
Name | Type | Description |
---|---|---|
userId | UUID | The user. |
idName | [OptionString] | The user's new ID name. |
realName | [OptionString] | The user's new real name. |
password | [OptionIdA1Password] | The user's new password |
IdA1CommandUserUpdatePasswordExpiration
A request to update the user's password expiration.
[record IdA1CommandUserUpdatePasswordExpiration [field userId UUID] [field set IdA1PasswordExpirationSet] ]
Fields
Name | Type | Description |
---|---|---|
userId | UUID | The user. |
set | IdA1PasswordExpirationSet | The set behaviour. |
IdA1Login
A login record.
IdA1Page
A page of results.
[record IdA1Page [parameter T] [field items [ListT]] [field pageIndex IntegerUnsigned32] [field pageCount IntegerUnsigned32] [field pageFirstOffset IntegerUnsigned64] ]
Parameters
Name | Description |
---|---|
T | The type of result values. |
Fields
Name | Type | Description |
---|---|---|
items | [ListT] | The list of results. |
pageIndex | IntegerUnsigned32 | The page index. |
pageCount | IntegerUnsigned32 | The page count. |
pageFirstOffset | IntegerUnsigned64 | The offset of the first item in the page. |
IdA1Password
Information for a hashed password.
[record IdA1Password [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. |
IdA1PasswordExpirationSet
The possible behaviours for setting password expirations.
[variant IdA1PasswordExpirationSet [case Never] [case Refresh] [case Specific [field time OffsetDateTime] ] ]
Cases
Case Never
The case Never has no fields.
Case Refresh
The case Refresh has no fields.
Case Specific
Name | Type | Description |
---|---|---|
time | OffsetDateTime |
IdA1ResponseAdminBanCreate
A response to IdA1CommandAdminBanCreate.
IdA1ResponseAdminBanDelete
A response to IdA1CommandAdminBanDelete.
[record IdA1ResponseAdminBanDelete [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdA1ResponseAdminBanGet
A response to IdA1CommandAdminBanGet.
IdA1ResponseAdminCreate
A response to IdA1CommandAdminCreate.
IdA1ResponseAdminDelete
A response to IdA1CommandAdminDelete.
[record IdA1ResponseAdminDelete [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdA1ResponseAdminGet
A response to IdA1CommandAdminGet.
IdA1ResponseAdminSearchBegin
A response to IdA1CommandAdminSearchBegin.
[record IdA1ResponseAdminSearchBegin [field requestId UUID] [field page [IdA1PageIdA1AdminSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AdminSummary] | The first page of results. |
IdA1ResponseAdminSearchByEmailBegin
A response to IdA1CommandAdminSearchByEmailBegin.
[record IdA1ResponseAdminSearchByEmailBegin [field requestId UUID] [field page [IdA1PageIdA1AdminSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AdminSummary] | The first page of results. |
IdA1ResponseAdminSearchByEmailNext
A response to IdA1CommandAdminSearchByEmailNext.
[record IdA1ResponseAdminSearchByEmailNext [field requestId UUID] [field page [IdA1PageIdA1AdminSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AdminSummary] | The next page of results. |
IdA1ResponseAdminSearchByEmailPrevious
A response to IdA1CommandAdminSearchByEmailPrevious.
[record IdA1ResponseAdminSearchByEmailPrevious [field requestId UUID] [field page [IdA1PageIdA1AdminSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AdminSummary] | The previous page of results. |
IdA1ResponseAdminSearchNext
A response to IdA1CommandAdminSearchNext.
[record IdA1ResponseAdminSearchNext [field requestId UUID] [field page [IdA1PageIdA1AdminSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AdminSummary] | The next page of results. |
IdA1ResponseAdminSearchPrevious
A response to IdA1CommandAdminSearchPrevious.
[record IdA1ResponseAdminSearchPrevious [field requestId UUID] [field page [IdA1PageIdA1AdminSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AdminSummary] | The previous page of results. |
IdA1ResponseAdminSelf
A response to IdA1CommandAdminSelf.
IdA1ResponseAdminUpdate
A response to IdA1CommandAdminUpdateCredentials.
IdA1ResponseAuditSearchBegin
A response to IdA1CommandAuditSearchBegin.
[record IdA1ResponseAuditSearchBegin [field requestId UUID] [field page [IdA1PageIdA1AuditEvent]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AuditEvent] | The first page of results. |
IdA1ResponseAuditSearchNext
A response to IdA1CommandAuditSearchNext.
[record IdA1ResponseAuditSearchNext [field requestId UUID] [field page [IdA1PageIdA1AuditEvent]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AuditEvent] | The next page of results. |
IdA1ResponseAuditSearchPrevious
A response to IdA1CommandAuditSearchPrevious.
[record IdA1ResponseAuditSearchPrevious [field requestId UUID] [field page [IdA1PageIdA1AuditEvent]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1AuditEvent] | The previous page of results. |
IdA1ResponseBlame
A blame assignment.
[variant IdA1ResponseBlame [case BlameClient] [case BlameServer] ]
Cases
Case BlameClient
The case BlameClient has no fields.
Case BlameServer
The case BlameServer has no fields.
IdA1ResponseError
An error response.
[record IdA1ResponseError [field requestId UUID] [field errorCode String] [field message String] [field attributes [MapStringString]] [field remediatingAction [OptionString]] [field blame IdA1ResponseBlame] ]
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 | IdA1ResponseBlame | The blame assignment. |
IdA1ResponseLogin
A response to IdA1CommandLogin.
IdA1ResponseMailTest
A response to IdA1CommandMailTest.
IdA1ResponseMaintenanceModeSet
A response to IdA1CommandMaintenanceModeSet.
IdA1ResponseUserBanCreate
A response to IdA1CommandUserBanCreate.
IdA1ResponseUserBanDelete
A response to IdA1CommandUserBanDelete.
[record IdA1ResponseUserBanDelete [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdA1ResponseUserBanGet
A response to IdA1CommandUserBanGet.
IdA1ResponseUserCreate
A response to IdA1CommandUserCreate.
IdA1ResponseUserDelete
A response to IdA1CommandUserDelete.
[record IdA1ResponseUserDelete [field requestId UUID] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
IdA1ResponseUserGet
A response to IdA1CommandUserGet.
IdA1ResponseUserLoginHistory
A response to IdA1CommandUserLoginHistory.
IdA1ResponseUserSearchBegin
A response to IdA1CommandUserSearchBegin.
[record IdA1ResponseUserSearchBegin [field requestId UUID] [field page [IdA1PageIdA1UserSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1UserSummary] | The first page of results. |
IdA1ResponseUserSearchByEmailBegin
A response to IdA1CommandUserSearchByEmailBegin.
[record IdA1ResponseUserSearchByEmailBegin [field requestId UUID] [field page [IdA1PageIdA1UserSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1UserSummary] | The first page of results. |
IdA1ResponseUserSearchByEmailNext
A response to IdA1CommandUserSearchByEmailNext.
[record IdA1ResponseUserSearchByEmailNext [field requestId UUID] [field page [IdA1PageIdA1UserSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1UserSummary] | The next page of results. |
IdA1ResponseUserSearchByEmailPrevious
A response to IdA1CommandUserSearchByEmailPrevious.
[record IdA1ResponseUserSearchByEmailPrevious [field requestId UUID] [field page [IdA1PageIdA1UserSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1UserSummary] | The previous page of results. |
IdA1ResponseUserSearchNext
A response to IdA1CommandUserSearchNext.
[record IdA1ResponseUserSearchNext [field requestId UUID] [field page [IdA1PageIdA1UserSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1UserSummary] | The next page of results. |
IdA1ResponseUserSearchPrevious
A response to IdA1CommandUserSearchPrevious.
[record IdA1ResponseUserSearchPrevious [field requestId UUID] [field page [IdA1PageIdA1UserSummary]] ]
Fields
Name | Type | Description |
---|---|---|
requestId | UUID | The ID of the request that yielded this response. |
page | [IdA1PageIdA1UserSummary] | The previous page of results. |
IdA1ResponseUserUpdate
A response to IdA1CommandUserUpdateCredentials.
IdA1TimeRange
A UTC time range.
[record IdA1TimeRange [field lower IdA1TimestampUTC] [field upper IdA1TimestampUTC] ]
Fields
Name | Type | Description |
---|---|---|
lower | IdA1TimestampUTC | The lower bound. |
upper | IdA1TimestampUTC | The upper bound. |
IdA1TimestampUTC
A UTC timestamp value.
[record IdA1TimestampUTC [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]. |
IdA1User
A user.
[record IdA1User [field id UUID] [field idName String] [field realName String] [field emails [ListString]] [field timeCreated IdA1TimestampUTC] [field timeUpdated IdA1TimestampUTC] [field password IdA1Password] ]
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 | IdA1TimestampUTC | The time the user was created. |
timeUpdated | IdA1TimestampUTC | The time the user was last updated. |
password | IdA1Password | The hashed user password. |
IdA1UserColumn
A column to use for sorting users.
[variant IdA1UserColumn [case ByID] [case ByIDName] [case ByRealName] [case ByTimeCreated] [case ByTimeUpdated] ]
Cases
Case ByID
The case ByID has no fields.
Case ByIDName
The case ByIDName has no fields.
Case ByRealName
The case ByRealName has no fields.
Case ByTimeCreated
The case ByTimeCreated has no fields.
Case ByTimeUpdated
The case ByTimeUpdated has no fields.
IdA1UserColumnOrdering
A column ordering spec.
[record IdA1UserColumnOrdering [field column IdA1UserColumn] [field ascending Boolean] ]
Fields
Name | Type | Description |
---|---|---|
column | IdA1UserColumn | The user column. |
ascending | Boolean | True if the results should be ascending. |
IdA1UserSearchByEmailParameters
Search parameters for users (by email).
[record IdA1UserSearchByEmailParameters [field timeCreatedRange IdA1TimeRange] [field timeUpdatedRange IdA1TimeRange] [field search String] [field ordering IdA1UserColumnOrdering] [field limit IntegerUnsigned16] ]
Fields
Name | Type | Description |
---|---|---|
timeCreatedRange | IdA1TimeRange | The range of creation times for returned users. |
timeUpdatedRange | IdA1TimeRange | The range of update times for returned users. |
search | String | The search query text. |
ordering | IdA1UserColumnOrdering | The result ordering. |
limit | IntegerUnsigned16 | The limit on the number of results. |
IdA1UserSearchParameters
Search parameters for users.
[record IdA1UserSearchParameters [field timeCreatedRange IdA1TimeRange] [field timeUpdatedRange IdA1TimeRange] [field search [OptionString]] [field ordering IdA1UserColumnOrdering] [field limit IntegerUnsigned16] ]
Fields
Name | Type | Description |
---|---|---|
timeCreatedRange | IdA1TimeRange | The range of creation times for returned users. |
timeUpdatedRange | IdA1TimeRange | The range of update times for returned users. |
search | [OptionString] | The search query text. |
ordering | IdA1UserColumnOrdering | The result ordering. |
limit | IntegerUnsigned16 | The limit on the number of results. |
IdA1UserSummary
A user summary.
[record IdA1UserSummary [field id UUID] [field idName String] [field realName String] [field timeCreated IdA1TimestampUTC] [field timeUpdated IdA1TimestampUTC] ]
Fields
Name | Type | Description |
---|---|---|
id | UUID | The user ID. |
idName | String | The user ID name. |
realName | String | The user real name. |
timeCreated | IdA1TimestampUTC | The time the user was created. |
timeUpdated | IdA1TimestampUTC | The time the user was last updated. |
IdA
Protocol identifier: 66ed46d0-7ff0-335b-a95c-82e996ebb8be
The Admin protocol.
Version 1 Messages
Name | Description |
---|---|
IdA1CommandAdminBanCreate | Ban an admin. |
IdA1CommandAdminBanDelete | Remove a ban on an admin. |
IdA1CommandAdminBanGet | Get a ban on an admin. |
IdA1CommandAdminCreate | Create an admin. |
IdA1CommandAdminDelete | Delete an admin. |
IdA1CommandAdminEmailAdd | Add an email address to the given admin. |
IdA1CommandAdminEmailRemove | Remove an email address from the given admin. |
IdA1CommandAdminGet | Get the given admin. |
IdA1CommandAdminGetByEmail | Get the admin with the given email address. |
IdA1CommandAdminPermissionGrant | Grant a permission to the given admin. |
IdA1CommandAdminPermissionRevoke | Revoke a permission from the given admin. |
IdA1CommandAdminSearchBegin | Start searching for admins. |
IdA1CommandAdminSearchByEmailBegin | Start searching for admins (by email). |
IdA1CommandAdminSearchByEmailNext | Get the next page of admin search results. |
IdA1CommandAdminSearchByEmailPrevious | Get the previous page of admin search results. |
IdA1CommandAdminSearchNext | Get the next page of admin search results. |
IdA1CommandAdminSearchPrevious | Get the previous page of admin search results. |
IdA1CommandAdminSelf | A request to fetch the admin's own profile. |
IdA1CommandAdminUpdateCredentials | A request to edit an admin's credentials. |
IdA1CommandAdminUpdatePasswordExpiration | A request to update the admin's password expiration. |
IdA1CommandAuditSearchBegin | Start searching/listing audit records. |
IdA1CommandAuditSearchNext | Get the next page of audit search results. |
IdA1CommandAuditSearchPrevious | Get the previous page of audit search results. |
IdA1CommandLogin | A request to log in. |
IdA1CommandMailTest | Send a test email to a given address. |
IdA1CommandMaintenanceModeSet | Move the server to/from maintenance mode. |
IdA1CommandUserBanCreate | Ban a user. |
IdA1CommandUserBanDelete | Remove a ban on a user. |
IdA1CommandUserBanGet | Get a ban on a user. |
IdA1CommandUserCreate | Create a user. |
IdA1CommandUserDelete | Delete a user. |
IdA1CommandUserEmailAdd | Add an email address to the given user. |
IdA1CommandUserEmailRemove | Remove an email address from the given user. |
IdA1CommandUserGet | Get the given user. |
IdA1CommandUserGetByEmail | Get the user with the given email address. |
IdA1CommandUserLoginHistory | Get the given user's login history. |
IdA1CommandUserSearchBegin | Start searching for users. |
IdA1CommandUserSearchByEmailBegin | Start searching for users (by email). |
IdA1CommandUserSearchByEmailNext | Get the next page of user search results. |
IdA1CommandUserSearchByEmailPrevious | Get the previous page of user search results. |
IdA1CommandUserSearchNext | Get the next page of user search results. |
IdA1CommandUserSearchPrevious | Get the previous page of user search results. |
IdA1CommandUserUpdateCredentials | A request to fetch the user's own profile. |
IdA1CommandUserUpdatePasswordExpiration | A request to update the user's password expiration. |
IdA1ResponseAdminBanCreate | A response to IdA1CommandAdminBanCreate. |
IdA1ResponseAdminBanDelete | A response to IdA1CommandAdminBanDelete. |
IdA1ResponseAdminBanGet | A response to IdA1CommandAdminBanGet. |
IdA1ResponseAdminCreate | A response to IdA1CommandAdminCreate. |
IdA1ResponseAdminDelete | A response to IdA1CommandAdminDelete. |
IdA1ResponseAdminGet | A response to IdA1CommandAdminGet. |
IdA1ResponseAdminSearchBegin | A response to IdA1CommandAdminSearchBegin. |
IdA1ResponseAdminSearchByEmailBegin | A response to IdA1CommandAdminSearchByEmailBegin. |
IdA1ResponseAdminSearchByEmailNext | A response to IdA1CommandAdminSearchByEmailNext. |
IdA1ResponseAdminSearchByEmailPrevious | A response to IdA1CommandAdminSearchByEmailPrevious. |
IdA1ResponseAdminSearchNext | A response to IdA1CommandAdminSearchNext. |
IdA1ResponseAdminSearchPrevious | A response to IdA1CommandAdminSearchPrevious. |
IdA1ResponseAdminSelf | A response to IdA1CommandAdminSelf. |
IdA1ResponseAdminUpdate | A response to IdA1CommandAdminUpdateCredentials. |
IdA1ResponseAuditSearchBegin | A response to IdA1CommandAuditSearchBegin. |
IdA1ResponseAuditSearchNext | A response to IdA1CommandAuditSearchNext. |
IdA1ResponseAuditSearchPrevious | A response to IdA1CommandAuditSearchPrevious. |
IdA1ResponseError | An error response. |
IdA1ResponseLogin | A response to IdA1CommandLogin. |
IdA1ResponseMailTest | A response to IdA1CommandMailTest. |
IdA1ResponseMaintenanceModeSet | A response to IdA1CommandMaintenanceModeSet. |
IdA1ResponseUserBanCreate | A response to IdA1CommandUserBanCreate. |
IdA1ResponseUserBanDelete | A response to IdA1CommandUserBanDelete. |
IdA1ResponseUserBanGet | A response to IdA1CommandUserBanGet. |
IdA1ResponseUserCreate | A response to IdA1CommandUserCreate. |
IdA1ResponseUserDelete | A response to IdA1CommandUserDelete. |
IdA1ResponseUserGet | A response to IdA1CommandUserGet. |
IdA1ResponseUserLoginHistory | A response to IdA1CommandUserLoginHistory. |
IdA1ResponseUserSearchBegin | A response to IdA1CommandUserSearchBegin. |
IdA1ResponseUserSearchByEmailBegin | A response to IdA1CommandUserSearchByEmailBegin. |
IdA1ResponseUserSearchByEmailNext | A response to IdA1CommandUserSearchByEmailNext. |
IdA1ResponseUserSearchByEmailPrevious | A response to IdA1CommandUserSearchByEmailPrevious. |
IdA1ResponseUserSearchNext | A response to IdA1CommandUserSearchNext. |
IdA1ResponseUserSearchPrevious | A response to IdA1CommandUserSearchPrevious. |
IdA1ResponseUserUpdate | A response to IdA1CommandUserUpdateCredentials. |