# Package com.io7m.idstore.protocol.admin.cb

@Export @Version("1.0.0") package com.io7m.idstore.protocol.admin.cb
Identity server (Admin Protocol v1 [Cedarbridge encoding])

- Related Packages
  Package
  Description
  com.io7m.idstore.protocol.admin
  Identity server (Admin Protocol)
  com.io7m.idstore.protocol.admin.cb.internal
  Identity server (Admin Protocol v1 [Cedarbridge encoding])
- Class
  Description
  IdA1Admin
  An administrator.
  IdA1AdminColumn
  A column to use for sorting admins.
  IdA1AdminColumn.ByID
  Order by admin ID.
  IdA1AdminColumn.ByIDName
  Order by admin id name.
  IdA1AdminColumn.ByRealName
  Order by admin realname.
  IdA1AdminColumn.ByTimeCreated
  Order by admin creation time.
  IdA1AdminColumn.ByTimeUpdated
  Order by admin update time.
  IdA1AdminColumnOrdering
  A column ordering spec.
  IdA1AdminPermission
  An admin permission.
  IdA1AdminPermission.AdminBan
  A permission that allows for banning admins.
  IdA1AdminPermission.AdminCreate
  A permission that allows for creating admins.
  IdA1AdminPermission.AdminDelete
  A permission that allows for deleting admins.
  IdA1AdminPermission.AdminRead
  A permission that allows reading admins.
  IdA1AdminPermission.AdminWriteCredentials
  A permission that allows updating admin credentials.
  IdA1AdminPermission.AdminWriteCredentialsSelf
  A permission that allows an admin to update its own credentials.
  IdA1AdminPermission.AdminWriteEmail
  A permission that allows updating admin emails.
  IdA1AdminPermission.AdminWriteEmailSelf
  A permission that allows an admin to update its own emails.
  IdA1AdminPermission.AdminWritePermissions
  A permission that allows updating admin permissions.
  IdA1AdminPermission.AdminWritePermissionsSelf
  A permission that allows an admin to update its own permissions.
  IdA1AdminPermission.AuditRead
  A permission that allows reading the audit log.
  IdA1AdminPermission.MailTest
  A permission that allows for sending test mail.
  IdA1AdminPermission.MaintenanceMode
  A permission that allows for changing the server's maintenance mode.
  IdA1AdminPermission.UserBan
  A permission that allows for banning users.
  IdA1AdminPermission.UserCreate
  A permission that allows creating users.
  IdA1AdminPermission.UserDelete
  A permission that allows deleting users.
  IdA1AdminPermission.UserRead
  A permission that allows reading users.
  IdA1AdminPermission.UserWriteCredentials
  A permission that allows updating user credentials.
  IdA1AdminPermission.UserWriteEmail
  A permission that allows updating user emails.
  IdA1AdminSearchByEmailParameters
  Search parameters for admins (by email).
  IdA1AdminSearchParameters
  Search parameters for admins.
  IdA1AdminSummary
  An admin summary.
  IdA1AuditEvent
  An audit event.
  IdA1AuditSearchParameters
  Search parameters for audit records.
  IdA1Ban
  An account ban.
  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.
  IdA1Login
  A login record.
  IdA1Page<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  A page of results.
  IdA1Password
  Information for a hashed password.
  IdA1PasswordExpirationSet
  The possible behaviours for setting password expirations.
  IdA1PasswordExpirationSet.Never
  Never expire, regardless of the server setting.
  IdA1PasswordExpirationSet.Refresh
  Refresh the password to the server setting.
  IdA1PasswordExpirationSet.Specific
  Expire at the given time, regardless of the server setting.
  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.
  IdA1ResponseBlame
  A blame assignment.
  IdA1ResponseBlame.BlameClient
  The client sent a bad response.
  IdA1ResponseBlame.BlameServer
  Something went wrong on the server.
  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.
  IdA1TimeRange
  A UTC time range.
  IdA1TimestampUTC
  A UTC timestamp value.
  IdA1User
  A user.
  IdA1UserColumn
  A column to use for sorting users.
  IdA1UserColumn.ByID
  Order by user ID.
  IdA1UserColumn.ByIDName
  Order by user id name.
  IdA1UserColumn.ByRealName
  Order by user realname.
  IdA1UserColumn.ByTimeCreated
  Order by user creation time.
  IdA1UserColumn.ByTimeUpdated
  Order by user update time.
  IdA1UserColumnOrdering
  A column ordering spec.
  IdA1UserSearchByEmailParameters
  Search parameters for users (by email).
  IdA1UserSearchParameters
  Search parameters for users.
  IdA1UserSummary
  A user summary.
  IdACB1Messages
  The protocol messages for Admin v1 Cedarbridge.
  IdACB1Validation
  Functions to translate between the core command set and the Admin v1 Cedarbridge encoding command set.
  ProtocolIdA
  Protocol `com.io7m.idstore.protocol.admin.cb.IdA`.
  ProtocolIdAType
  Protocol `com.io7m.idstore.protocol.admin.cb.IdA`
  ProtocolIdAv1Serializer
  Protocol `com.io7m.idstore.protocol.admin.cb.IdA`, version `1`.
  ProtocolIdAv1Type
  Protocol `com.io7m.idstore.protocol.admin.cb.IdA`, version `1`.