Module api_model

Module api_model 

Source

Modules§

app_permissions
key_operations
user_flags

Structs§

Account
AccountApprovalPolicy
Account approval policy.
AccountRequest
AgreeKeyRequest
Request to perform key agreement.
App
AppCredentialResponse
App credential response.
AppGroups
AppPermissions
Operations allowed to be performed by an app.
AppRequest
AppResetSecretRequest
ApprovableResult
ApprovalAuthConfig
Authentication requirements for approval request reviewers.
ApprovalPolicy
Approval policy.
ApprovalPolicyQuorum
Quorum approval policy.
ApprovalRequest
ApprovalRequestRequest
ApproveRequest
AuthConfig
Account authentication settings.
AuthConfigLdap
LDAP authentication settings.
AuthConfigOauth
OAuth single sign-on authentication settings.
AuthConfigPassword
Password authentication settings.
AuthConfigSignedJwt
Signed JWT authentication settings.
AuthResponse
BatchDecryptRequestItem
BatchEncryptRequestItem
Blob
Arbitrary binary data that is serialized/deserialized to/from base 64 string.
Config2faAuthRequest
Request to start configuring U2F.
Config2faAuthResponse
CountParams
DecryptFinalRequest
Finalize a multi-part decryption.
DecryptFinalResponse
Final result of a multi-part decryption.
DecryptInitRequest
Initialize multi-part decryption. AEAD ciphers are not currently supported in this mode.
DecryptInitResponse
Result of initializing multi-part decryption.
DecryptRequest
A request to decrypt data using a symmetric or asymmetric key.
DecryptResponse
Result of a decryption.
DecryptUpdateRequest
Multi-part decryption request.
DecryptUpdateResponse
Result of multi-part decryption.
DeriveKeyRequest
Request to derive a key.
DigestRequest
Request to compute the hash of arbitrary data.
DigestResponse
Result of a hash operation.
EncryptFinalRequest
Finalize a multi-part encryption.
EncryptFinalResponse
Final result of a multi-part encryption.
EncryptInitRequest
Initialize multi-part encryption. AEAD ciphers are not currently supported in this mode.
EncryptInitResponse
Result of initializing multi-part encryption.
EncryptRequest
A request to encrypt data using a symmetric or asymmetric key.
EncryptResponse
Result of an encryption.
EncryptUpdateRequest
Multi-part encryption request.
EncryptUpdateResponse
Result of multi-part encryption.
ExternalRole
ExternalRoleRequest
ForgotPasswordRequest
Initiate password reset sequence.
FpeOptions
FPE-specific options.
GetAccountParams
GetAppParams
GetSobjectParams
GetUsageResponse
GoogleServiceAccountKey
A Google service account key object. See https://cloud.google.com/video-intelligence/docs/common/auth.
Group
GroupRequest
KeyLinks
Linked security objects.
KeyOperations
Operations allowed to be performed on a given key.
LdapAuthorizationConfig
LDAP authorization settings.
LdapServiceAccount
Credentials used by the service to authenticate itself to an LDAP server.
ListApprovalRequestsParams
ListAppsParams
ListExternalRolesParams
ListPluginsParams
ListSobjectsParams
ListUsersParams
MacRequest
Request for HMAC or CMAC operation.
MacResponse
Result of HMAC or CMAC operation.
MfaChallengeResponse
A challenge used for multi-factor authentication.
ObjectCounts
Counts of objects of various types in an account.
ObjectDigestRequest
Request to compute digest of a key.
ObjectDigestResponse
Digest of a key.
OperationAccountUsage
OperationActivateSobject
OperationAgree
OperationApproveRequest
OperationBatchSign
OperationBatchVerify
OperationChangePassword
OperationConfig2faAuth
OperationConfig2faTerminate
OperationCreateAccount
OperationCreateApp
OperationCreateApprovalRequest
OperationCreateDigest
OperationCreateExternalRole
OperationCreateGroup
OperationCreatePlugin
OperationCreateSobject
OperationDecrypt
OperationDecryptFinal
OperationDecryptInit
OperationDecryptUpdate
OperationDeleteAccount
OperationDeleteApp
OperationDeleteApprovalRequest
OperationDeleteExternalRole
OperationDeleteGroup
OperationDeletePlugin
OperationDeleteSobject
OperationDeleteUser
OperationDeleteUserAccount
OperationDenyRequest
OperationDerive
OperationDigestSobject
OperationEncrypt
OperationEncryptFinal
OperationEncryptInit
OperationEncryptUpdate
OperationExportSobject
OperationForgotPassword
OperationGenerateRecoveryCodes
OperationGetAccount
OperationGetApp
OperationGetAppCredential
OperationGetApprovalRequest
OperationGetApprovalRequestResult
OperationGetExternalRole
OperationGetGroup
OperationGetPlugin
OperationGetSobject
OperationGetUser
OperationGetUserAccounts
OperationImportSobject
OperationInviteUser
OperationInvokePlugin
OperationListAccounts
OperationListApprovalRequests
OperationListApps
OperationListExternalRoles
OperationListGroups
OperationListPlugins
OperationListSobjects
OperationListUsers
OperationMac
OperationMacVerify
OperationPersistTransientKey
OperationProcessInvite
OperationRecoveryCodeAuth
OperationRefresh
OperationRemovePrivate
OperationResendInvite
OperationResetAppSecret
OperationResetPassword
OperationRevokeSobject
OperationRotateSobject
OperationSelectAccount
OperationSign
OperationSignupUser
OperationSyncExternalRole
OperationU2fAuth
OperationU2fNewChallenge
OperationUnwrap
OperationUpdateAccount
OperationUpdateApp
OperationUpdateExternalRole
OperationUpdateGroup
OperationUpdatePlugin
OperationUpdateSobject
OperationUpdateUser
OperationVerify
OperationVersion
OperationWrap
PasswordChangeRequest
Request to change user’s password.
PasswordResetRequest
Request to perform a password reset.
PersistTransientKeyRequest
Request to persist a transient key.
Plugin
PluginRequest
PluginVersion
ProcessInviteRequest
Accept/reject invitations to join account.
RecoveryCodeAuthRequest
Request to authenticate using U2F recovery code.
RecoveryCodes
U2F recovery codes.
Reviewer
Reviewer of an approval request.
RevocationReason
Reason for revoking a key.
RsaEncryptionPolicy
Constraints on RSA encryption parameters. In general, if a constraint is not specified, anything is allowed.
RsaOptions
RSA-specific options.
RsaSignaturePolicy
Constraints on RSA signature parameters. In general, if a constraint is not specified, anything is allowed.
SelectAccountRequest
Request to select an account.
SelectAccountResponse
Response to select account request.
SignRequest
A request to sign data (or hash value) using an asymmetric key.
SignResponse
Result of sign operation.
SignupRequest
Request to signup a new user.
Sobject
SobjectRequest
SplunkLoggingConfig
Splunk logging configuration.
SplunkLoggingConfigRequest
StackdriverLoggingConfig
Stackdriver logging configuration.
StackdriverLoggingConfigRequest
SubscriptionChangeRequest
A request to update subscription type.
SyslogLoggingConfig
SyslogLoggingConfigRequest
Time
Time stores the number of seconds since Unix epoch.
TrustAnchor
A trusted CA for app authentication.
U2fAddDeviceRequest
Description of a U2F device to add for two factor authentication.
U2fAuthRequest
Request for second factor authentication with a U2f device.
U2fDelDeviceRequest
Request to delete a U2F device.
U2fDevice
A U2f device that may be used for second factor authentication.
U2fRegisteredKey
Description of a registered U2F device.
U2fRenameDeviceRequest
Request to rename a U2F device.
UnwrapKeyRequest
Request to perform key unwrapping.
User
UserAccountFlags
User’s role and state in an account.
UserRequest
VerifyMacRequest
Rquest to verify a MAC value.
VerifyRequest
Request to verify a signature using an asymmetric key.
VerifyResponse
Result of verifying a signature or MAC.
VersionResponse
Information about the service version.
WrapKeyRequest
Request to perform key wrapping.
WrapKeyResponse
Result of key wrapping operation.

Enums§

AgreeKeyMechanism
Mechanism to use for key agreement.
Algorithm
A cryptographic algorithm.
AppAuthType
Authentication method of an app.
AppCredential
App authentication mechanisms.
AppOauthConfig
OAuth settings for an app. If enabled, an app can request to act on behalf of a user.
AppSort
ApprovalStatus
Approval request status.
ApprovalSubject
Identifies an object acted upon by an approval request.
BatchResponseItem
CaConfig
CA settings.
CaSet
Predefined CA sets.
CipherMode
Cipher mode used for symmetric key algorithms.
CryptMode
CipherMode or RsaEncryptionPadding, depending on the encryption algorithm.
DeriveKeyMechanism
Encodes the mechanism to be used when deriving a new key from an existing key. Currently, the only supported mechanism is encrypting data to derive the new key. Other mechanisms may be added in the future.
DigestAlgorithm
A hash algorithm.
EllipticCurve
Identifies a standardized elliptic curve.
Error
ExternalRoleKind
Type of an external role.
JwtSigningKeys
Signing keys used to validate signed JWT tokens.
Language
Language of plugin code.
LdapDnResolution
Distinguished Name (DN) resolution method. Given a user’s email address, a DN resolution method is used to find the user’s DN in an LDAP directory.
LoggingConfig
LoggingConfigRequest
Mgf
Specifies the Mask Generating Function (MGF) to use.
MgfPolicy
MGF policy.
NotificationPref
Notification preferences.
OauthScope
OAuth scope.
ObjectOrigin
The origin of a security object - where it was created / generated.
ObjectType
Type of security object.
Order
PluginSort
PluginSource
Plugin code that will be executed inside SGX enclave.
PluginSourceRequest
PluginType
Type of a plugin.
Principal
A security principal.
PublishPublicKeyConfig
If enabled, the public key will be available publicly (without authentication) through the GetPublicKey API.
ReviewerPrincipal
A Principal who can approve or deny an approval request.
RevocationReasonCode
Reasons to revoke a security object.
RsaEncryptionPadding
Type of padding to use for RSA encryption. The use of PKCS#1 v1.5 padding is strongly discouraged, because of its susceptibility to Bleichenbacher’s attack. The padding specified must adhere to the key’s encryption policy. If not specified, the default based on the key’s policy will be used.
RsaEncryptionPaddingPolicy
RSA encryption padding policy.
RsaSignaturePadding
Type of padding to use for RSA signatures. The padding specified must adhere to the key’s signature policy. If not specified, the default based on the key’s policy will be used.
RsaSignaturePaddingPolicy
RSA signature padding policy.
ServerMode
Server mode.
SignatureMode
Signature mode.
SobjectDescriptor
Uniquely identifies a persisted or transient sobject.
SobjectEncoding
SobjectSort
SobjectState
SubscriptionType
Type of subscription.
SyslogFacility
Syslog facility.
TimeOutOfRange
TlsConfig
TLS settings.
UserGroupRole
User’s role in a group.
UserSort

Type Aliases§

BatchDecryptRequest
BatchEncryptRequest
BatchResponse
BatchSignRequest
BatchVerifyRequest
Email
Name
PluginOutput