func GetBadUserStateAuthenticateUserResultUserStateEnumStringValues() []string
GetBadUserStateAuthenticateUserResultUserStateEnumStringValues Enumerates the set of values in String for BadUserStateAuthenticateUserResultUserStateEnum
func GetCompartmentMetadataAccessLevelEnumStringValues() []string
GetCompartmentMetadataAccessLevelEnumStringValues Enumerates the set of values in String for CompartmentMetadataAccessLevelEnum
func GetContextVariableTypeEnumStringValues() []string
GetContextVariableTypeEnumStringValues Enumerates the set of values in String for ContextVariableTypeEnum
func GetIdentityProviderProtocolEnumStringValues() []string
GetIdentityProviderProtocolEnumStringValues Enumerates the set of values in String for IdentityProviderProtocolEnum
func GetThinAssociationAuthorizationResponseAssociationResultEnumStringValues() []string
GetThinAssociationAuthorizationResponseAssociationResultEnumStringValues Enumerates the set of values in String for ThinAssociationAuthorizationResponseAssociationResultEnum
AccessibleCompartmentRequest The representation of AccessibleCompartmentRequest
type AccessibleCompartmentRequest struct {
// The authorization request.
AuthorizationRequest *AuthorizationRequest `mandatory:"true" json:"authorizationRequest"`
// The list of compartment ids.
CompartmentIds []string `mandatory:"true" json:"compartmentIds"`
}
func (m AccessibleCompartmentRequest) String() string
func (m AccessibleCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AccessibleCompartmentResponse The representation of AccessibleCompartmentResponse
type AccessibleCompartmentResponse struct {
// The compartments metadata.
CompartmentsMetadata []CompartmentMetadata `mandatory:"true" json:"compartmentsMetadata"`
}
func (m AccessibleCompartmentResponse) String() string
func (m AccessibleCompartmentResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AssociationAuthorizationRequest The representation of AssociationAuthorizationRequest
type AssociationAuthorizationRequest struct {
// The list of authorization requests.
Requests []AuthorizationRequest `mandatory:"true" json:"requests"`
}
func (m AssociationAuthorizationRequest) String() string
func (m AssociationAuthorizationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthServiceUser The representation of AuthServiceUser
type AuthServiceUser struct {
// The id of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The id of the tenant.
TenantId *string `mandatory:"true" json:"tenantId"`
// The user's Oracle ID (OCID).
Id *string `mandatory:"true" json:"id"`
// The name of the user.
Name *string `mandatory:"true" json:"name"`
// The display name of the user.
DisplayName *string `mandatory:"true" json:"displayName"`
}
func (m AuthServiceUser) String() string
func (m AuthServiceUser) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthenticateClientDetails The representation of AuthenticateClientDetails
type AuthenticateClientDetails struct {
// The signed headers of the original caller's request.
RequestHeaders map[string][]string `mandatory:"true" json:"requestHeaders"`
}
func (m AuthenticateClientDetails) String() string
func (m AuthenticateClientDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthenticateClientResult The representation of AuthenticateClientResult
type AuthenticateClientResult struct {
// The original caller's resolved principal object if the authentication succeeds, null otherwise.
Principal *Principal `mandatory:"false" json:"principal"`
// If the authentication fails for the original caller (not failing authentication of the calling service, in which case we return 401), we return a 200, but with null principal and an error message
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
}
func (m AuthenticateClientResult) String() string
func (m AuthenticateClientResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthenticateUserResult See ValidAuthenticateUserResult, BadUserStateAuthenticateUserResult, UserNotFoundAuthenticateUserResult, TenantNotFoundAuthenticateUserResult
type AuthenticateUserResult struct {
// The tenant name.
TenantInput *string `mandatory:"true" json:"tenantInput"`
// The user name.
UserInput *string `mandatory:"true" json:"userInput"`
}
func (m AuthenticateUserResult) String() string
func (m AuthenticateUserResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthenticationPolicy Authentication policy, currently set for the given compartment
type AuthenticationPolicy struct {
// Password policy.
PasswordPolicy *PasswordPolicy `mandatory:"false" json:"passwordPolicy"`
// Compartment OCID.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
}
func (m AuthenticationPolicy) String() string
func (m AuthenticationPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthenticationPrincipal The representation of AuthenticationPrincipal
type AuthenticationPrincipal struct {
// The tenancy object.
Tenant *Tenant `mandatory:"true" json:"tenant"`
// The user object.
User *User `mandatory:"true" json:"user"`
}
func (m AuthenticationPrincipal) String() string
func (m AuthenticationPrincipal) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthenticationRequest The representation of AuthenticationRequest
type AuthenticationRequest struct {
// The user name
UserName *string `mandatory:"true" json:"userName"`
// The password
Password *string `mandatory:"true" json:"password"`
// The name of the tenancy
TenantName *string `mandatory:"true" json:"tenantName"`
}
func (m AuthenticationRequest) String() string
func (m AuthenticationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AuthorizationRequest The representation of AuthorizationRequest
type AuthorizationRequest struct {
// The id of this request. It is a GUID.
RequestId *string `mandatory:"true" json:"requestId"`
// The user principal object
UserPrincipal *Principal `mandatory:"true" json:"userPrincipal"`
// The service principal object for service to service calls.
SvcPrincipal *Principal `mandatory:"true" json:"svcPrincipal"`
// The name of the service that is making this authorization request
ServiceName *string `mandatory:"true" json:"serviceName"`
// A set of permission contexts
Context []PermissionContext `mandatory:"true" json:"context"`
// The hash of cached policy on the caller service side. If this is different than what Identity has, it will
// send the most recent policy statements.
PolicyHash *string `mandatory:"true" json:"policyHash"`
}
func (m AuthorizationRequest) String() string
func (m AuthorizationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BadUserStateAuthenticateUserResult The representation of BadUserStateAuthenticateUserResult
type BadUserStateAuthenticateUserResult struct {
// The tenant name.
TenantInput *string `mandatory:"true" json:"tenantInput"`
// The user name.
UserInput *string `mandatory:"true" json:"userInput"`
// The resolved tenant id.
ResolvedTenantId *string `mandatory:"true" json:"resolvedTenantId"`
// The resolved user id.
ResolvedUserId *string `mandatory:"true" json:"resolvedUserId"`
// The bad user state.
UserState BadUserStateAuthenticateUserResultUserStateEnum `mandatory:"true" json:"userState"`
}
func (m BadUserStateAuthenticateUserResult) String() string
func (m BadUserStateAuthenticateUserResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BadUserStateAuthenticateUserResultUserStateEnum Enum with underlying type: string
type BadUserStateAuthenticateUserResultUserStateEnum string
Set of constants representing the allowable values for BadUserStateAuthenticateUserResultUserStateEnum
const (
BadUserStateAuthenticateUserResultUserStateUserBlocked BadUserStateAuthenticateUserResultUserStateEnum = "USER_BLOCKED"
BadUserStateAuthenticateUserResultUserStateUserDisabled BadUserStateAuthenticateUserResultUserStateEnum = "USER_DISABLED"
BadUserStateAuthenticateUserResultUserStateOneTimePasswordExpired BadUserStateAuthenticateUserResultUserStateEnum = "ONE_TIME_PASSWORD_EXPIRED"
BadUserStateAuthenticateUserResultUserStatePasswordInvalid BadUserStateAuthenticateUserResultUserStateEnum = "PASSWORD_INVALID"
)
func GetBadUserStateAuthenticateUserResultUserStateEnumValues() []BadUserStateAuthenticateUserResultUserStateEnum
GetBadUserStateAuthenticateUserResultUserStateEnumValues Enumerates the set of values for BadUserStateAuthenticateUserResultUserStateEnum
func GetMappingBadUserStateAuthenticateUserResultUserStateEnum(val string) (BadUserStateAuthenticateUserResultUserStateEnum, bool)
GetMappingBadUserStateAuthenticateUserResultUserStateEnum performs case Insensitive comparison on enum value and return the desired enum
Claim The representation of Claim
type Claim struct {
// The key of the claim.
Key *string `mandatory:"true" json:"key"`
// The value of the claim.
Value *string `mandatory:"true" json:"value"`
// The issuer of the claim.
Issuer *string `mandatory:"false" json:"issuer"`
}
func (m Claim) String() string
func (m Claim) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ClientCredentialsResponse The representation of ClientCredentialsResponse
type ClientCredentialsResponse struct {
// The access token.
AccessToken *string `mandatory:"true" json:"access_token"`
// The token type.
TokenType *string `mandatory:"true" json:"token_type"`
// The amount of time until the token expires.
ExpiresIn *string `mandatory:"true" json:"expires_in"`
}
func (m ClientCredentialsResponse) String() string
func (m ClientCredentialsResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CommonPrincipal The representation of CommonPrincipal
type CommonPrincipal struct {
// The tenant.
Tenant *Tenant `mandatory:"true" json:"tenant"`
// The user.
User *User `mandatory:"true" json:"user"`
}
func (m CommonPrincipal) String() string
func (m CommonPrincipal) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Compartment The representation of Compartment
type Compartment struct {
// The id of the compartment.
Id *string `mandatory:"true" json:"id"`
// The name of the compartment.
Name *string `mandatory:"true" json:"name"`
// The display name of the compartment.
DisplayName *string `mandatory:"true" json:"displayName"`
// The full name of the compartment.
FullName *string `mandatory:"true" json:"fullName"`
// The id of the parent compartment.
ParentCompartmentId *string `mandatory:"true" json:"parentCompartmentId"`
// The status of the compartment.
Status *EntityStatus `mandatory:"true" json:"status"`
// The extended properties.
PropertyMap map[string]string `mandatory:"true" json:"propertyMap"`
}
func (m Compartment) String() string
func (m Compartment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CompartmentMetadata The representation of CompartmentMetadata
type CompartmentMetadata struct {
// The compartment id.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The access level.
AccessLevel CompartmentMetadataAccessLevelEnum `mandatory:"true" json:"accessLevel"`
}
func (m CompartmentMetadata) String() string
func (m CompartmentMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CompartmentMetadataAccessLevelEnum Enum with underlying type: string
type CompartmentMetadataAccessLevelEnum string
Set of constants representing the allowable values for CompartmentMetadataAccessLevelEnum
const (
CompartmentMetadataAccessLevelAccessible CompartmentMetadataAccessLevelEnum = "accessible"
CompartmentMetadataAccessLevelVisible CompartmentMetadataAccessLevelEnum = "visible"
CompartmentMetadataAccessLevelInaccessible CompartmentMetadataAccessLevelEnum = "inaccessible"
)
func GetCompartmentMetadataAccessLevelEnumValues() []CompartmentMetadataAccessLevelEnum
GetCompartmentMetadataAccessLevelEnumValues Enumerates the set of values for CompartmentMetadataAccessLevelEnum
func GetMappingCompartmentMetadataAccessLevelEnum(val string) (CompartmentMetadataAccessLevelEnum, bool)
GetMappingCompartmentMetadataAccessLevelEnum performs case Insensitive comparison on enum value and return the desired enum
ContextVariable The representation of ContextVariable
type ContextVariable struct {
// The name of the variable.
Name *string `mandatory:"true" json:"name"`
// The value of the variable.
Value *string `mandatory:"true" json:"value"`
// The type of the variable.
Type ContextVariableTypeEnum `mandatory:"true" json:"type"`
}
func (m ContextVariable) String() string
func (m ContextVariable) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ContextVariableTypeEnum Enum with underlying type: string
type ContextVariableTypeEnum string
Set of constants representing the allowable values for ContextVariableTypeEnum
const (
ContextVariableTypeString ContextVariableTypeEnum = "STRING"
ContextVariableTypeNumber ContextVariableTypeEnum = "NUMBER"
ContextVariableTypeEntity ContextVariableTypeEnum = "ENTITY"
ContextVariableTypeBoolean ContextVariableTypeEnum = "BOOLEAN"
ContextVariableTypeList ContextVariableTypeEnum = "LIST"
)
func GetContextVariableTypeEnumValues() []ContextVariableTypeEnum
GetContextVariableTypeEnumValues Enumerates the set of values for ContextVariableTypeEnum
func GetMappingContextVariableTypeEnum(val string) (ContextVariableTypeEnum, bool)
GetMappingContextVariableTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CostTrackingTag The representation of CostTrackingTag
type CostTrackingTag struct {
// The tag namespace id.
TagNamespaceId *string `mandatory:"true" json:"Tag_Namespace_Id"`
// The tag namespace name.
TagNamespaceName *string `mandatory:"true" json:"Tag_Namespace_Name"`
// The tag definition id.
TagDefinitionId *string `mandatory:"true" json:"Tag_Definition_Id"`
// The tag definition name.
TagDefinitionName *string `mandatory:"true" json:"Tag_Definition_Name"`
}
func (m CostTrackingTag) String() string
func (m CostTrackingTag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CredentialAuthenticatorInfo The representation of CredentialAuthenticatorInfo
type CredentialAuthenticatorInfo struct {
// The raw credential.
RawCredential *string `mandatory:"true" json:"rawCredential"`
// The id of the user.
UserId *string `mandatory:"true" json:"userId"`
// The id of the tenant.
TenantId *string `mandatory:"true" json:"tenantId"`
// The name of the user.
UserName *string `mandatory:"true" json:"userName"`
// The name of the tenant.
TenantName *string `mandatory:"true" json:"tenantName"`
// The credential identifier.
CredentialIdentifier *string `mandatory:"true" json:"credentialIdentifier"`
// The credential list.
CredentialList []string `mandatory:"true" json:"credentialList"`
// The name of the service that is making this authorization request.
Service *string `mandatory:"true" json:"service"`
// The id of the client.
ClientId *string `mandatory:"true" json:"clientId"`
}
func (m CredentialAuthenticatorInfo) String() string
func (m CredentialAuthenticatorInfo) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DataplaneClient a client for Dataplane
type DataplaneClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDataplaneClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataplaneClient, err error)
NewDataplaneClientWithConfigurationProvider Creates a new default Dataplane client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDataplaneClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataplaneClient, err error)
NewDataplaneClientWithOboToken Creates a new default Dataplane client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *DataplaneClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DataplaneClient) GenerateScopedAccessToken(ctx context.Context, request GenerateScopedAccessTokenRequest) (response GenerateScopedAccessTokenResponse, err error)
GenerateScopedAccessToken Based on the calling Principal and the input payload, derive the claims, and generate a scoped-access token for specific resources. For example, set scope to urn:oracle:db::id::<compartment-id> for access to a database in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identitydataplane/GenerateScopedAccessToken.go.html to see an example of how to use GenerateScopedAccessToken API.
func (client DataplaneClient) GenerateUserSecurityToken(ctx context.Context, request GenerateUserSecurityTokenRequest) (response GenerateUserSecurityTokenResponse, err error)
GenerateUserSecurityToken Exchanges a valid user token-based signature (API key and UPST) for a short-lived UPST of the authenticated user principal. When not specified, the user session duration is set to a default of 60 minutes in all realms. Resulting UPSTs are refreshable while the user session has not expired.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identitydataplane/GenerateUserSecurityToken.go.html to see an example of how to use GenerateUserSecurityToken API.
func (client *DataplaneClient) SetRegion(region string)
SetRegion overrides the region of this client.
DerivedKeyResponse The representation of DerivedKeyResponse
type DerivedKeyResponse struct {
// The derived key.
SigningKey *string `mandatory:"true" json:"signingKey"`
// The principal.
Principal *CommonPrincipal `mandatory:"true" json:"principal"`
}
func (m DerivedKeyResponse) String() string
func (m DerivedKeyResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EntityStatus The representation of EntityStatus
type EntityStatus struct {
// The entity status.
Status *string `mandatory:"true" json:"status"`
// A bit mask showing the reason why the entity is inactive:
// - bit 0: ACTIVE
// - bit 1: SUSPENDED
// - bit 2: DISABLED
// - bit 3: BLOCKED
// - bit 4: LOCKED
InactiveBitMask *int64 `mandatory:"true" json:"inactiveBitMask"`
}
func (m EntityStatus) String() string
func (m EntityStatus) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FilterGroupMembershipDetails The representation of FilterGroupMembershipDetails
type FilterGroupMembershipDetails struct {
// A resolved principal object
Principal *Principal `mandatory:"true" json:"principal"`
// An array of group or dynamic group Ids the resolved principal potentially belongs to.
GroupIds []string `mandatory:"true" json:"groupIds"`
}
func (m FilterGroupMembershipDetails) String() string
func (m FilterGroupMembershipDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FilterGroupMembershipResult The representation of FilterGroupMembershipResult
type FilterGroupMembershipResult struct {
// Return passed-in resolved principal object
Principal *Principal `mandatory:"true" json:"principal"`
// An array of group or dynamic group Ids which present the intersection between the passed-in group/dynamic-group and the actual group/dynamic-group the resovled principal belongs to.
GroupIds []string `mandatory:"true" json:"groupIds"`
}
func (m FilterGroupMembershipResult) String() string
func (m FilterGroupMembershipResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateScopedAccessTokenDetails The representation of GenerateScopedAccessTokenDetails
type GenerateScopedAccessTokenDetails struct {
// Scope definition for the scoped access token
Scope *string `mandatory:"true" json:"scope"`
// A temporary public key, owned by the service. The service also owns the corresponding private key. This public
// key will be put inside the security token by the auth service after successful validation of the certificate.
PublicKey *string `mandatory:"true" json:"publicKey"`
}
func (m GenerateScopedAccessTokenDetails) String() string
func (m GenerateScopedAccessTokenDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateScopedAccessTokenRequest wrapper for the GenerateScopedAccessToken operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identitydataplane/GenerateScopedAccessToken.go.html to see an example of how to use GenerateScopedAccessTokenRequest.
type GenerateScopedAccessTokenRequest struct {
// Scoped access token request
GenerateScopedAccessTokenDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GenerateScopedAccessTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateScopedAccessTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateScopedAccessTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateScopedAccessTokenRequest) String() string
func (request GenerateScopedAccessTokenRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateScopedAccessTokenResponse wrapper for the GenerateScopedAccessToken operation
type GenerateScopedAccessTokenResponse struct {
// The underlying http response
RawResponse *http.Response
// The SecurityToken instance
SecurityToken `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GenerateScopedAccessTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateScopedAccessTokenResponse) String() string
GenerateUserSecurityTokenDetails Request parameters in body for obtaining a user principal session token (UPST) for self.
type GenerateUserSecurityTokenDetails struct {
// The user-owned public key in PEM format that corresponds to the RSA key pair used for signing requests.
// The user also owns the corresponding private key. This public key will be put inside the user
// security token by the auth service after successful validation of the request.
PublicKey *string `mandatory:"true" json:"publicKey"`
// User session expiration in minutes to which the requested user principal session token (UPST) is bounded.
// Valid values are from 5 to 60 for all realms.
SessionExpirationInMinutes *int `mandatory:"false" json:"sessionExpirationInMinutes"`
}
func (m GenerateUserSecurityTokenDetails) String() string
func (m GenerateUserSecurityTokenDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateUserSecurityTokenRequest wrapper for the GenerateUserSecurityToken operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identitydataplane/GenerateUserSecurityToken.go.html to see an example of how to use GenerateUserSecurityTokenRequest.
type GenerateUserSecurityTokenRequest struct {
// The key-value pair object storing the token exchange request parameters required to obtain a UPST for self.
GenerateUserSecurityTokenDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GenerateUserSecurityTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateUserSecurityTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateUserSecurityTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateUserSecurityTokenRequest) String() string
func (request GenerateUserSecurityTokenRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateUserSecurityTokenResponse wrapper for the GenerateUserSecurityToken operation
type GenerateUserSecurityTokenResponse struct {
// The underlying http response
RawResponse *http.Response
// The SecurityToken instance
SecurityToken `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GenerateUserSecurityTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateUserSecurityTokenResponse) String() string
IdentityProvider The representation of IdentityProvider
type IdentityProvider struct {
// The id of the provider.
Id *string `mandatory:"true" json:"id"`
// The name of the provider.
Name *string `mandatory:"true" json:"name"`
// The name of the tenant.
TenantName *string `mandatory:"true" json:"tenantName"`
// The id of the tenant.
TenantId *string `mandatory:"true" json:"tenantId"`
// The SAML endpoint where user will be redirected.
RedirectUri *string `mandatory:"true" json:"redirectUri"`
// The signing certificate of the provider.
SigningCertificate *string `mandatory:"true" json:"signingCertificate"`
// The type of the provider.
Protocol IdentityProviderProtocolEnum `mandatory:"true" json:"protocol"`
// The id of the service provider entity.
ServiceProviderEntityId *string `mandatory:"true" json:"serviceProviderEntityId"`
// Whether to force authentication.
ForceAuthentication *bool `mandatory:"true" json:"forceAuthentication"`
// Authentication context class refs.
AuthnContextClassRefs []string `mandatory:"true" json:"authnContextClassRefs"`
}
func (m IdentityProvider) String() string
func (m IdentityProvider) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IdentityProviderProtocolEnum Enum with underlying type: string
type IdentityProviderProtocolEnum string
Set of constants representing the allowable values for IdentityProviderProtocolEnum
const (
IdentityProviderProtocolSaml2 IdentityProviderProtocolEnum = "SAML2"
)
func GetIdentityProviderProtocolEnumValues() []IdentityProviderProtocolEnum
GetIdentityProviderProtocolEnumValues Enumerates the set of values for IdentityProviderProtocolEnum
func GetMappingIdentityProviderProtocolEnum(val string) (IdentityProviderProtocolEnum, bool)
GetMappingIdentityProviderProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
Jwk The representation of Jwk
type Jwk struct {
// The modulus.
N *string `mandatory:"true" json:"n"`
// The exponent.
E *string `mandatory:"true" json:"e"`
// The key id.
Kid *string `mandatory:"true" json:"kid"`
// The key use.
Use *string `mandatory:"true" json:"use"`
// The algorithm.
Alg *string `mandatory:"true" json:"alg"`
// The key type.
Kty *string `mandatory:"true" json:"kty"`
}
func (m Jwk) String() string
func (m Jwk) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OnBehalfOfRequest The representation of OnBehalfOfRequest
type OnBehalfOfRequest struct {
// The signed headers of the customer call.
RequestHeaders map[string][]string `mandatory:"true" json:"requestHeaders"`
// The name of the target service.
TargetServiceName *string `mandatory:"true" json:"targetServiceName"`
// If you have an obo token already, exchange that for a new obo token.
OboToken *string `mandatory:"false" json:"oboToken"`
// A duration for which the obo token is requested to be valid.
Expiration *string `mandatory:"false" json:"expiration"`
}
func (m OnBehalfOfRequest) String() string
func (m OnBehalfOfRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PasswordPolicy Password policy, currently set for the given compartment.
type PasswordPolicy struct {
// Minimum password length required.
MinimumPasswordLength *int `mandatory:"false" json:"minimumPasswordLength"`
// At least one uppercase character required.
IsUppercaseCharactersRequired *bool `mandatory:"false" json:"isUppercaseCharactersRequired"`
// At least one lower case character required.
IsLowercaseCharactersRequired *bool `mandatory:"false" json:"isLowercaseCharactersRequired"`
// At least one numeric character required.
IsNumericCharactersRequired *bool `mandatory:"false" json:"isNumericCharactersRequired"`
// At least one special character required.
IsSpecialCharactersRequired *bool `mandatory:"false" json:"isSpecialCharactersRequired"`
// User name is allowed to be part of the password.
IsUsernameContainmentAllowed *bool `mandatory:"false" json:"isUsernameContainmentAllowed"`
}
func (m PasswordPolicy) String() string
func (m PasswordPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PasswordResetAuthenticationRequest The representation of PasswordResetAuthenticationRequest
type PasswordResetAuthenticationRequest struct {
// The id of the user
UserId *string `mandatory:"true" json:"userId"`
// The password reset token
PasswordResetToken *string `mandatory:"true" json:"passwordResetToken"`
}
func (m PasswordResetAuthenticationRequest) String() string
func (m PasswordResetAuthenticationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Permission The representation of Permission
type Permission struct {
// The name of the permission.
P *string `mandatory:"true" json:"p"`
}
func (m Permission) String() string
func (m Permission) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PermissionContext The representation of PermissionContext
type PermissionContext struct {
// The permission context.
Permission *Permission `mandatory:"true" json:"permission"`
// The set of variables in this permission context.
Variables []ContextVariable `mandatory:"true" json:"variables"`
}
func (m PermissionContext) String() string
func (m PermissionContext) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Principal The representation of Principal
type Principal struct {
// The user's OCID.
SubjectId *string `mandatory:"true" json:"subjectId"`
// The tenancy OCID.
TenantId *string `mandatory:"true" json:"tenantId"`
// The set of claims for this principal.
Claims []Claim `mandatory:"true" json:"claims"`
}
func (m Principal) String() string
func (m Principal) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RefreshRequest The representation of RefreshRequest
type RefreshRequest struct {
// The current security token that is to be renewed.
CurrentToken *string `mandatory:"true" json:"currentToken"`
// An optional new public for the new token. If not supplied, currentToken's public key will be used.
NewPublicKey *string `mandatory:"false" json:"newPublicKey"`
}
func (m RefreshRequest) String() string
func (m RefreshRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourcePrincipalSessionTokenRequest The representation of ResourcePrincipalSessionTokenRequest
type ResourcePrincipalSessionTokenRequest struct {
// The resource principal token.
ResourcePrincipalToken *string `mandatory:"true" json:"resourcePrincipalToken"`
// The service principal session token.
ServicePrincipalSessionToken *string `mandatory:"true" json:"servicePrincipalSessionToken"`
// The session public key.
SessionPublicKey *string `mandatory:"true" json:"sessionPublicKey"`
}
func (m ResourcePrincipalSessionTokenRequest) String() string
func (m ResourcePrincipalSessionTokenRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SecurityToken The representation of SecurityToken
type SecurityToken struct {
// The security token, signed by auth service
Token *string `mandatory:"true" json:"token"`
}
func (m SecurityToken) String() string
func (m SecurityToken) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Tenant The representation of Tenant
type Tenant struct {
// The tenant's Oracle ID (OCID).
Id *string `mandatory:"true" json:"id"`
// The name of the tenancy.
Name *string `mandatory:"true" json:"name"`
// The service namespace.
ServiceNamespace *string `mandatory:"false" json:"serviceNamespace"`
}
func (m Tenant) String() string
func (m Tenant) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TenantNotFoundAuthenticateUserResult The representation of TenantNotFoundAuthenticateUserResult
type TenantNotFoundAuthenticateUserResult struct {
// The tenant name.
TenantInput *string `mandatory:"true" json:"tenantInput"`
// The user name.
UserInput *string `mandatory:"true" json:"userInput"`
}
func (m TenantNotFoundAuthenticateUserResult) String() string
func (m TenantNotFoundAuthenticateUserResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThickAuthorizationResponse The representation of ThickAuthorizationResponse
type ThickAuthorizationResponse struct {
// The policy string related to the request
Policy *string `mandatory:"true" json:"policy"`
// The duration of how long this policy should be cached. Note that the type is of type java.time.Duration, not
// string.
PolicyCacheDuration *string `mandatory:"true" json:"policyCacheDuration"`
// The policy string related to the request.
Groups []string `mandatory:"true" json:"groups"`
// The duration of how long the user's group membership should be cached. Note that the type is of type
// java.time.Duration, not string.
GroupMembershipCacheDuration *string `mandatory:"true" json:"groupMembershipCacheDuration"`
// If set to true, the SDK should clear the caches.
FlushAllCaches *bool `mandatory:"false" json:"flushAllCaches"`
}
func (m ThickAuthorizationResponse) String() string
func (m ThickAuthorizationResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThinAssociationAuthorizationResponse The representation of ThinAssociationAuthorizationResponse
type ThinAssociationAuthorizationResponse struct {
// The authorization responses.
Responses []ThinAuthorizationResponse `mandatory:"true" json:"responses"`
// The association verification result.
AssociationResult ThinAssociationAuthorizationResponseAssociationResultEnum `mandatory:"true" json:"associationResult"`
// The decision cache duration.
DecisionCacheDuration *string `mandatory:"false" json:"decisionCacheDuration"`
}
func (m ThinAssociationAuthorizationResponse) String() string
func (m ThinAssociationAuthorizationResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThinAssociationAuthorizationResponseAssociationResultEnum Enum with underlying type: string
type ThinAssociationAuthorizationResponseAssociationResultEnum string
Set of constants representing the allowable values for ThinAssociationAuthorizationResponseAssociationResultEnum
const (
ThinAssociationAuthorizationResponseAssociationResultFailUnknown ThinAssociationAuthorizationResponseAssociationResultEnum = "FAIL_UNKNOWN"
ThinAssociationAuthorizationResponseAssociationResultFailBadRequest ThinAssociationAuthorizationResponseAssociationResultEnum = "FAIL_BAD_REQUEST"
ThinAssociationAuthorizationResponseAssociationResultFailMissingEndorse ThinAssociationAuthorizationResponseAssociationResultEnum = "FAIL_MISSING_ENDORSE"
ThinAssociationAuthorizationResponseAssociationResultFailMissingAdmit ThinAssociationAuthorizationResponseAssociationResultEnum = "FAIL_MISSING_ADMIT"
ThinAssociationAuthorizationResponseAssociationResultSuccess ThinAssociationAuthorizationResponseAssociationResultEnum = "SUCCESS"
)
func GetMappingThinAssociationAuthorizationResponseAssociationResultEnum(val string) (ThinAssociationAuthorizationResponseAssociationResultEnum, bool)
GetMappingThinAssociationAuthorizationResponseAssociationResultEnum performs case Insensitive comparison on enum value and return the desired enum
func GetThinAssociationAuthorizationResponseAssociationResultEnumValues() []ThinAssociationAuthorizationResponseAssociationResultEnum
GetThinAssociationAuthorizationResponseAssociationResultEnumValues Enumerates the set of values for ThinAssociationAuthorizationResponseAssociationResultEnum
ThinAuthorizationResponse The representation of ThinAuthorizationResponse
type ThinAuthorizationResponse struct {
// The policy string related to the request.
AuthorizationRequest *AuthorizationRequest `mandatory:"true" json:"authorizationRequest"`
// The duration of how long this decision should be cached. Note that the type is of type java.time.Duration, not
// string.
DecisionCacheDuration *string `mandatory:"true" json:"decisionCacheDuration"`
}
func (m ThinAuthorizationResponse) String() string
func (m ThinAuthorizationResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
User The representation of User
type User struct {
// The user's Oracle ID (OCID).
Id *string `mandatory:"true" json:"id"`
// The name of the user.
Name *string `mandatory:"true" json:"name"`
// If the provided password is a one-time password.
IsOTP *bool `mandatory:"true" json:"isOTP"`
// If mfa is activated.
IsMfaActivated *bool `mandatory:"true" json:"isMfaActivated"`
// If the user has been mfa verified.
IsMfaVerified *bool `mandatory:"true" json:"isMfaVerified"`
}
func (m User) String() string
func (m User) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UserNotFoundAuthenticateUserResult The representation of UserNotFoundAuthenticateUserResult
type UserNotFoundAuthenticateUserResult struct {
// The tenant name.
TenantInput *string `mandatory:"true" json:"tenantInput"`
// The user name.
UserInput *string `mandatory:"true" json:"userInput"`
// The resolved tenant id.
ResolvedTenantId *string `mandatory:"true" json:"resolvedTenantId"`
}
func (m UserNotFoundAuthenticateUserResult) String() string
func (m UserNotFoundAuthenticateUserResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ValidAuthenticateUserResult The representation of ValidAuthenticateUserResult
type ValidAuthenticateUserResult struct {
// The tenant name.
TenantInput *string `mandatory:"true" json:"tenantInput"`
// The user name.
UserInput *string `mandatory:"true" json:"userInput"`
// The resolved principal.
ResolvedPrincipal *AuthenticationPrincipal `mandatory:"true" json:"resolvedPrincipal"`
}
func (m ValidAuthenticateUserResult) String() string
func (m ValidAuthenticateUserResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
X509FederationRequest The representation of X509FederationRequest
type X509FederationRequest struct {
// The x509 certificate of the service instance, issued by his CA.
Certificate *string `mandatory:"true" json:"certificate"`
// A temporary public key, owned by the service. The service also owns the corresponding private key. This public
// key will be put inside the security token by the auth service after successful validation of the certificate.
PublicKey *string `mandatory:"true" json:"publicKey"`
// An array of intermediate certificates to form the chain from the leaf certificate to the root CA. If auth
// service already has the intermediate certificate(s), then this is not required.
IntermediateCertificates []string `mandatory:"false" json:"intermediateCertificates"`
}
func (m X509FederationRequest) String() string
func (m X509FederationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly