identitydataplane

type AccessibleCompartmentRequest struct {

	// The authorization request.
	AuthorizationRequest *AuthorizationRequest `mandatory:"true" json:"authorizationRequest"`

	// The list of compartment ids.
	CompartmentIds []string `mandatory:"true" json:"compartmentIds"`
}

type AccessibleCompartmentResponse struct {

	// The compartments metadata.
	CompartmentsMetadata []CompartmentMetadata `mandatory:"true" json:"compartmentsMetadata"`
}

type AssociationAuthorizationRequest struct {

	// The list of authorization requests.
	Requests []AuthorizationRequest `mandatory:"true" json:"requests"`
}

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"`
}

type AuthenticateClientDetails struct {

	// The signed headers of the original caller's request.
	RequestHeaders map[string][]string `mandatory:"true" json:"requestHeaders"`
}

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"`
}

type AuthenticateUserResult struct {

	// The tenant name.
	TenantInput *string `mandatory:"true" json:"tenantInput"`

	// The user name.
	UserInput *string `mandatory:"true" json:"userInput"`
}

type AuthenticationPolicy struct {

	// Password policy.
	PasswordPolicy *PasswordPolicy `mandatory:"false" json:"passwordPolicy"`

	// Compartment OCID.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`
}

type AuthenticationPrincipal struct {

	// The tenancy object.
	Tenant *Tenant `mandatory:"true" json:"tenant"`

	// The user object.
	User *User `mandatory:"true" json:"user"`
}

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"`
}

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"`
}

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"`
}

type BadUserStateAuthenticateUserResultUserStateEnum string

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"`
}

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"`
}

type CommonPrincipal struct {

	// The tenant.
	Tenant *Tenant `mandatory:"true" json:"tenant"`

	// The user.
	User *User `mandatory:"true" json:"user"`
}

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"`
}

type CompartmentMetadata struct {

	// The compartment id.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The access level.
	AccessLevel CompartmentMetadataAccessLevelEnum `mandatory:"true" json:"accessLevel"`
}

type CompartmentMetadataAccessLevelEnum string

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"`
}

type ContextVariableTypeEnum string

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"`
}

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"`
}

type DataplaneClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

type DerivedKeyResponse struct {

	// The derived key.
	SigningKey *string `mandatory:"true" json:"signingKey"`

	// The principal.
	Principal *CommonPrincipal `mandatory:"true" json:"principal"`
}

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"`
}

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"`
}

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"`
}

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 by put inside the security token by the auth service after successful validation of the certificate.
	PublicKey *string `mandatory:"true" json:"publicKey"`
}

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
}

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"`
}

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"`
}

type IdentityProviderProtocolEnum string

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"`
}

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"`
}

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"`
}

type PasswordResetAuthenticationRequest struct {

	// The id of the user
	UserId *string `mandatory:"true" json:"userId"`

	// The password reset token
	PasswordResetToken *string `mandatory:"true" json:"passwordResetToken"`
}

type Permission struct {

	// The name of the permission.
	P *string `mandatory:"true" json:"p"`
}

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"`
}

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"`
}

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"`
}

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"`
}

type SecurityToken struct {

	// The security token, signed by auth service
	Token *string `mandatory:"true" json:"token"`
}

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"`
}

type TenantNotFoundAuthenticateUserResult struct {

	// The tenant name.
	TenantInput *string `mandatory:"true" json:"tenantInput"`

	// The user name.
	UserInput *string `mandatory:"true" json:"userInput"`
}

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"`
}

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"`
}

type ThinAssociationAuthorizationResponseAssociationResultEnum string

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"`
}

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"`
}

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"`
}

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"`
}

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 by 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"`
}