identity

package
v65.64.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 23, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 20

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetAddLockDetailsTypeEnumStringValues ¶ added in v65.9.0

func GetAddLockDetailsTypeEnumStringValues() []string

GetAddLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddLockDetailsTypeEnum

func GetApiKeyLifecycleStateEnumStringValues ¶

func GetApiKeyLifecycleStateEnumStringValues() []string

GetApiKeyLifecycleStateEnumStringValues Enumerates the set of values in String for ApiKeyLifecycleStateEnum

func GetAuthTokenLifecycleStateEnumStringValues ¶

func GetAuthTokenLifecycleStateEnumStringValues() []string

GetAuthTokenLifecycleStateEnumStringValues Enumerates the set of values in String for AuthTokenLifecycleStateEnum

func GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues ¶

func GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues() []string

GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues Enumerates the set of values in String for BaseTagDefinitionValidatorValidatorTypeEnum

func GetBulkEditOperationDetailsOperationTypeEnumStringValues ¶

func GetBulkEditOperationDetailsOperationTypeEnumStringValues() []string

GetBulkEditOperationDetailsOperationTypeEnumStringValues Enumerates the set of values in String for BulkEditOperationDetailsOperationTypeEnum

func GetCompartmentLifecycleStateEnumStringValues ¶

func GetCompartmentLifecycleStateEnumStringValues() []string

GetCompartmentLifecycleStateEnumStringValues Enumerates the set of values in String for CompartmentLifecycleStateEnum

func GetCreateIdentityProviderDetailsProductTypeEnumStringValues ¶

func GetCreateIdentityProviderDetailsProductTypeEnumStringValues() []string

GetCreateIdentityProviderDetailsProductTypeEnumStringValues Enumerates the set of values in String for CreateIdentityProviderDetailsProductTypeEnum

func GetCreateIdentityProviderDetailsProtocolEnumStringValues ¶

func GetCreateIdentityProviderDetailsProtocolEnumStringValues() []string

GetCreateIdentityProviderDetailsProtocolEnumStringValues Enumerates the set of values in String for CreateIdentityProviderDetailsProtocolEnum

func GetCustomerSecretKeyLifecycleStateEnumStringValues ¶

func GetCustomerSecretKeyLifecycleStateEnumStringValues() []string

GetCustomerSecretKeyLifecycleStateEnumStringValues Enumerates the set of values in String for CustomerSecretKeyLifecycleStateEnum

func GetCustomerSecretKeySummaryLifecycleStateEnumStringValues ¶

func GetCustomerSecretKeySummaryLifecycleStateEnumStringValues() []string

GetCustomerSecretKeySummaryLifecycleStateEnumStringValues Enumerates the set of values in String for CustomerSecretKeySummaryLifecycleStateEnum

func GetDbCredentialLifecycleStateEnumStringValues ¶

func GetDbCredentialLifecycleStateEnumStringValues() []string

GetDbCredentialLifecycleStateEnumStringValues Enumerates the set of values in String for DbCredentialLifecycleStateEnum

func GetDomainLifecycleDetailsEnumStringValues ¶

func GetDomainLifecycleDetailsEnumStringValues() []string

GetDomainLifecycleDetailsEnumStringValues Enumerates the set of values in String for DomainLifecycleDetailsEnum

func GetDomainLifecycleStateEnumStringValues ¶

func GetDomainLifecycleStateEnumStringValues() []string

GetDomainLifecycleStateEnumStringValues Enumerates the set of values in String for DomainLifecycleStateEnum

func GetDomainSummaryLifecycleDetailsEnumStringValues ¶

func GetDomainSummaryLifecycleDetailsEnumStringValues() []string

GetDomainSummaryLifecycleDetailsEnumStringValues Enumerates the set of values in String for DomainSummaryLifecycleDetailsEnum

func GetDomainTypeEnumStringValues ¶

func GetDomainTypeEnumStringValues() []string

GetDomainTypeEnumStringValues Enumerates the set of values in String for DomainTypeEnum

func GetDynamicGroupLifecycleStateEnumStringValues ¶

func GetDynamicGroupLifecycleStateEnumStringValues() []string

GetDynamicGroupLifecycleStateEnumStringValues Enumerates the set of values in String for DynamicGroupLifecycleStateEnum

func GetGroupLifecycleStateEnumStringValues ¶

func GetGroupLifecycleStateEnumStringValues() []string

GetGroupLifecycleStateEnumStringValues Enumerates the set of values in String for GroupLifecycleStateEnum

func GetIamWorkRequestOperationTypeEnumStringValues ¶

func GetIamWorkRequestOperationTypeEnumStringValues() []string

GetIamWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for IamWorkRequestOperationTypeEnum

func GetIamWorkRequestResourceActionTypeEnumStringValues ¶

func GetIamWorkRequestResourceActionTypeEnumStringValues() []string

GetIamWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for IamWorkRequestResourceActionTypeEnum

func GetIamWorkRequestStatusEnumStringValues ¶

func GetIamWorkRequestStatusEnumStringValues() []string

GetIamWorkRequestStatusEnumStringValues Enumerates the set of values in String for IamWorkRequestStatusEnum

func GetIamWorkRequestSummaryOperationTypeEnumStringValues ¶

func GetIamWorkRequestSummaryOperationTypeEnumStringValues() []string

GetIamWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for IamWorkRequestSummaryOperationTypeEnum

func GetIamWorkRequestSummaryStatusEnumStringValues ¶

func GetIamWorkRequestSummaryStatusEnumStringValues() []string

GetIamWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for IamWorkRequestSummaryStatusEnum

func GetIdentityProviderLifecycleStateEnumStringValues ¶

func GetIdentityProviderLifecycleStateEnumStringValues() []string

GetIdentityProviderLifecycleStateEnumStringValues Enumerates the set of values in String for IdentityProviderLifecycleStateEnum

func GetIdpGroupMappingLifecycleStateEnumStringValues ¶

func GetIdpGroupMappingLifecycleStateEnumStringValues() []string

GetIdpGroupMappingLifecycleStateEnumStringValues Enumerates the set of values in String for IdpGroupMappingLifecycleStateEnum

func GetListBulkActionResourceTypesBulkActionTypeEnumStringValues ¶

func GetListBulkActionResourceTypesBulkActionTypeEnumStringValues() []string

GetListBulkActionResourceTypesBulkActionTypeEnumStringValues Enumerates the set of values in String for ListBulkActionResourceTypesBulkActionTypeEnum

func GetListCompartmentsAccessLevelEnumStringValues ¶

func GetListCompartmentsAccessLevelEnumStringValues() []string

GetListCompartmentsAccessLevelEnumStringValues Enumerates the set of values in String for ListCompartmentsAccessLevelEnum

func GetListCompartmentsSortByEnumStringValues ¶

func GetListCompartmentsSortByEnumStringValues() []string

GetListCompartmentsSortByEnumStringValues Enumerates the set of values in String for ListCompartmentsSortByEnum

func GetListCompartmentsSortOrderEnumStringValues ¶

func GetListCompartmentsSortOrderEnumStringValues() []string

GetListCompartmentsSortOrderEnumStringValues Enumerates the set of values in String for ListCompartmentsSortOrderEnum

func GetListDbCredentialsSortByEnumStringValues ¶

func GetListDbCredentialsSortByEnumStringValues() []string

GetListDbCredentialsSortByEnumStringValues Enumerates the set of values in String for ListDbCredentialsSortByEnum

func GetListDbCredentialsSortOrderEnumStringValues ¶

func GetListDbCredentialsSortOrderEnumStringValues() []string

GetListDbCredentialsSortOrderEnumStringValues Enumerates the set of values in String for ListDbCredentialsSortOrderEnum

func GetListDomainsSortByEnumStringValues ¶

func GetListDomainsSortByEnumStringValues() []string

GetListDomainsSortByEnumStringValues Enumerates the set of values in String for ListDomainsSortByEnum

func GetListDomainsSortOrderEnumStringValues ¶

func GetListDomainsSortOrderEnumStringValues() []string

GetListDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListDomainsSortOrderEnum

func GetListDynamicGroupsSortByEnumStringValues ¶

func GetListDynamicGroupsSortByEnumStringValues() []string

GetListDynamicGroupsSortByEnumStringValues Enumerates the set of values in String for ListDynamicGroupsSortByEnum

func GetListDynamicGroupsSortOrderEnumStringValues ¶

func GetListDynamicGroupsSortOrderEnumStringValues() []string

GetListDynamicGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListDynamicGroupsSortOrderEnum

func GetListGroupsSortByEnumStringValues ¶

func GetListGroupsSortByEnumStringValues() []string

GetListGroupsSortByEnumStringValues Enumerates the set of values in String for ListGroupsSortByEnum

func GetListGroupsSortOrderEnumStringValues ¶

func GetListGroupsSortOrderEnumStringValues() []string

GetListGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListGroupsSortOrderEnum

func GetListIamWorkRequestErrorsSortOrderEnumStringValues ¶

func GetListIamWorkRequestErrorsSortOrderEnumStringValues() []string

GetListIamWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListIamWorkRequestErrorsSortOrderEnum

func GetListIamWorkRequestLogsSortOrderEnumStringValues ¶

func GetListIamWorkRequestLogsSortOrderEnumStringValues() []string

GetListIamWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListIamWorkRequestLogsSortOrderEnum

func GetListIdentityProvidersProtocolEnumStringValues ¶

func GetListIdentityProvidersProtocolEnumStringValues() []string

GetListIdentityProvidersProtocolEnumStringValues Enumerates the set of values in String for ListIdentityProvidersProtocolEnum

func GetListIdentityProvidersSortByEnumStringValues ¶

func GetListIdentityProvidersSortByEnumStringValues() []string

GetListIdentityProvidersSortByEnumStringValues Enumerates the set of values in String for ListIdentityProvidersSortByEnum

func GetListIdentityProvidersSortOrderEnumStringValues ¶

func GetListIdentityProvidersSortOrderEnumStringValues() []string

GetListIdentityProvidersSortOrderEnumStringValues Enumerates the set of values in String for ListIdentityProvidersSortOrderEnum

func GetListMfaTotpDevicesSortByEnumStringValues ¶

func GetListMfaTotpDevicesSortByEnumStringValues() []string

GetListMfaTotpDevicesSortByEnumStringValues Enumerates the set of values in String for ListMfaTotpDevicesSortByEnum

func GetListMfaTotpDevicesSortOrderEnumStringValues ¶

func GetListMfaTotpDevicesSortOrderEnumStringValues() []string

GetListMfaTotpDevicesSortOrderEnumStringValues Enumerates the set of values in String for ListMfaTotpDevicesSortOrderEnum

func GetListNetworkSourcesSortByEnumStringValues ¶

func GetListNetworkSourcesSortByEnumStringValues() []string

GetListNetworkSourcesSortByEnumStringValues Enumerates the set of values in String for ListNetworkSourcesSortByEnum

func GetListNetworkSourcesSortOrderEnumStringValues ¶

func GetListNetworkSourcesSortOrderEnumStringValues() []string

GetListNetworkSourcesSortOrderEnumStringValues Enumerates the set of values in String for ListNetworkSourcesSortOrderEnum

func GetListPoliciesSortByEnumStringValues ¶

func GetListPoliciesSortByEnumStringValues() []string

GetListPoliciesSortByEnumStringValues Enumerates the set of values in String for ListPoliciesSortByEnum

func GetListPoliciesSortOrderEnumStringValues ¶

func GetListPoliciesSortOrderEnumStringValues() []string

GetListPoliciesSortOrderEnumStringValues Enumerates the set of values in String for ListPoliciesSortOrderEnum

func GetListUsersSortByEnumStringValues ¶

func GetListUsersSortByEnumStringValues() []string

GetListUsersSortByEnumStringValues Enumerates the set of values in String for ListUsersSortByEnum

func GetListUsersSortOrderEnumStringValues ¶

func GetListUsersSortOrderEnumStringValues() []string

GetListUsersSortOrderEnumStringValues Enumerates the set of values in String for ListUsersSortOrderEnum

func GetMfaTotpDeviceLifecycleStateEnumStringValues ¶

func GetMfaTotpDeviceLifecycleStateEnumStringValues() []string

GetMfaTotpDeviceLifecycleStateEnumStringValues Enumerates the set of values in String for MfaTotpDeviceLifecycleStateEnum

func GetMfaTotpDeviceSummaryLifecycleStateEnumStringValues ¶

func GetMfaTotpDeviceSummaryLifecycleStateEnumStringValues() []string

GetMfaTotpDeviceSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for MfaTotpDeviceSummaryLifecycleStateEnum

func GetNetworkSourcesLifecycleStateEnumStringValues ¶

func GetNetworkSourcesLifecycleStateEnumStringValues() []string

GetNetworkSourcesLifecycleStateEnumStringValues Enumerates the set of values in String for NetworkSourcesLifecycleStateEnum

func GetOAuth2ClientCredentialLifecycleStateEnumStringValues ¶

func GetOAuth2ClientCredentialLifecycleStateEnumStringValues() []string

GetOAuth2ClientCredentialLifecycleStateEnumStringValues Enumerates the set of values in String for OAuth2ClientCredentialLifecycleStateEnum

func GetOAuth2ClientCredentialSummaryLifecycleStateEnumStringValues ¶

func GetOAuth2ClientCredentialSummaryLifecycleStateEnumStringValues() []string

GetOAuth2ClientCredentialSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for OAuth2ClientCredentialSummaryLifecycleStateEnum

func GetPolicyLifecycleStateEnumStringValues ¶

func GetPolicyLifecycleStateEnumStringValues() []string

GetPolicyLifecycleStateEnumStringValues Enumerates the set of values in String for PolicyLifecycleStateEnum

func GetRegionSubscriptionStatusEnumStringValues ¶

func GetRegionSubscriptionStatusEnumStringValues() []string

GetRegionSubscriptionStatusEnumStringValues Enumerates the set of values in String for RegionSubscriptionStatusEnum

func GetRemoveLockDetailsTypeEnumStringValues ¶ added in v65.9.0

func GetRemoveLockDetailsTypeEnumStringValues() []string

GetRemoveLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveLockDetailsTypeEnum

func GetReplicatedRegionDetailsStateEnumStringValues ¶

func GetReplicatedRegionDetailsStateEnumStringValues() []string

GetReplicatedRegionDetailsStateEnumStringValues Enumerates the set of values in String for ReplicatedRegionDetailsStateEnum

func GetResourceLockTypeEnumStringValues ¶ added in v65.9.0

func GetResourceLockTypeEnumStringValues() []string

GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum

func GetSmtpCredentialLifecycleStateEnumStringValues ¶

func GetSmtpCredentialLifecycleStateEnumStringValues() []string

GetSmtpCredentialLifecycleStateEnumStringValues Enumerates the set of values in String for SmtpCredentialLifecycleStateEnum

func GetSmtpCredentialSummaryLifecycleStateEnumStringValues ¶

func GetSmtpCredentialSummaryLifecycleStateEnumStringValues() []string

GetSmtpCredentialSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for SmtpCredentialSummaryLifecycleStateEnum

func GetStandardTagDefinitionTemplateEnumMutabilityEnumStringValues ¶

func GetStandardTagDefinitionTemplateEnumMutabilityEnumStringValues() []string

GetStandardTagDefinitionTemplateEnumMutabilityEnumStringValues Enumerates the set of values in String for StandardTagDefinitionTemplateEnumMutabilityEnum

func GetStandardTagDefinitionTemplateTypeEnumStringValues ¶

func GetStandardTagDefinitionTemplateTypeEnumStringValues() []string

GetStandardTagDefinitionTemplateTypeEnumStringValues Enumerates the set of values in String for StandardTagDefinitionTemplateTypeEnum

func GetSwiftPasswordLifecycleStateEnumStringValues ¶

func GetSwiftPasswordLifecycleStateEnumStringValues() []string

GetSwiftPasswordLifecycleStateEnumStringValues Enumerates the set of values in String for SwiftPasswordLifecycleStateEnum

func GetTagDefaultLifecycleStateEnumStringValues ¶

func GetTagDefaultLifecycleStateEnumStringValues() []string

GetTagDefaultLifecycleStateEnumStringValues Enumerates the set of values in String for TagDefaultLifecycleStateEnum

func GetTagDefaultSummaryLifecycleStateEnumStringValues ¶

func GetTagDefaultSummaryLifecycleStateEnumStringValues() []string

GetTagDefaultSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for TagDefaultSummaryLifecycleStateEnum

func GetTagLifecycleStateEnumStringValues ¶

func GetTagLifecycleStateEnumStringValues() []string

GetTagLifecycleStateEnumStringValues Enumerates the set of values in String for TagLifecycleStateEnum

func GetTagNamespaceLifecycleStateEnumStringValues ¶

func GetTagNamespaceLifecycleStateEnumStringValues() []string

GetTagNamespaceLifecycleStateEnumStringValues Enumerates the set of values in String for TagNamespaceLifecycleStateEnum

func GetTaggingWorkRequestOperationTypeEnumStringValues ¶

func GetTaggingWorkRequestOperationTypeEnumStringValues() []string

GetTaggingWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for TaggingWorkRequestOperationTypeEnum

func GetTaggingWorkRequestStatusEnumStringValues ¶

func GetTaggingWorkRequestStatusEnumStringValues() []string

GetTaggingWorkRequestStatusEnumStringValues Enumerates the set of values in String for TaggingWorkRequestStatusEnum

func GetTaggingWorkRequestSummaryOperationTypeEnumStringValues ¶

func GetTaggingWorkRequestSummaryOperationTypeEnumStringValues() []string

GetTaggingWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for TaggingWorkRequestSummaryOperationTypeEnum

func GetTaggingWorkRequestSummaryStatusEnumStringValues ¶

func GetTaggingWorkRequestSummaryStatusEnumStringValues() []string

GetTaggingWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for TaggingWorkRequestSummaryStatusEnum

func GetUiPasswordInformationLifecycleStateEnumStringValues ¶

func GetUiPasswordInformationLifecycleStateEnumStringValues() []string

GetUiPasswordInformationLifecycleStateEnumStringValues Enumerates the set of values in String for UiPasswordInformationLifecycleStateEnum

func GetUiPasswordLifecycleStateEnumStringValues ¶

func GetUiPasswordLifecycleStateEnumStringValues() []string

GetUiPasswordLifecycleStateEnumStringValues Enumerates the set of values in String for UiPasswordLifecycleStateEnum

func GetUpdateIdentityProviderDetailsProtocolEnumStringValues ¶

func GetUpdateIdentityProviderDetailsProtocolEnumStringValues() []string

GetUpdateIdentityProviderDetailsProtocolEnumStringValues Enumerates the set of values in String for UpdateIdentityProviderDetailsProtocolEnum

func GetUserGroupMembershipLifecycleStateEnumStringValues ¶

func GetUserGroupMembershipLifecycleStateEnumStringValues() []string

GetUserGroupMembershipLifecycleStateEnumStringValues Enumerates the set of values in String for UserGroupMembershipLifecycleStateEnum

func GetUserLifecycleStateEnumStringValues ¶

func GetUserLifecycleStateEnumStringValues() []string

GetUserLifecycleStateEnumStringValues Enumerates the set of values in String for UserLifecycleStateEnum

func GetWorkRequestOperationTypeEnumStringValues ¶

func GetWorkRequestOperationTypeEnumStringValues() []string

GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum

func GetWorkRequestResourceActionTypeEnumStringValues ¶

func GetWorkRequestResourceActionTypeEnumStringValues() []string

GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum

func GetWorkRequestStatusEnumStringValues ¶

func GetWorkRequestStatusEnumStringValues() []string

GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum

func GetWorkRequestSummaryOperationTypeEnumStringValues ¶

func GetWorkRequestSummaryOperationTypeEnumStringValues() []string

GetWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestSummaryOperationTypeEnum

func GetWorkRequestSummaryStatusEnumStringValues ¶

func GetWorkRequestSummaryStatusEnumStringValues() []string

GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum

Types ¶

type ActivateDomainRequest ¶

type ActivateDomainRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

ActivateDomainRequest wrapper for the ActivateDomain operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ActivateDomain.go.html to see an example of how to use ActivateDomainRequest.

func (ActivateDomainRequest) BinaryRequestBody ¶

func (request ActivateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ActivateDomainRequest) HTTPRequest ¶

func (request ActivateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ActivateDomainRequest) RetryPolicy ¶

func (request ActivateDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ActivateDomainRequest) String ¶

func (request ActivateDomainRequest) String() string

func (ActivateDomainRequest) ValidateEnumValue ¶

func (request ActivateDomainRequest) 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

type ActivateDomainResponse ¶

type ActivateDomainResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ActivateDomainResponse wrapper for the ActivateDomain operation

func (ActivateDomainResponse) HTTPResponse ¶

func (response ActivateDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ActivateDomainResponse) String ¶

func (response ActivateDomainResponse) String() string

type ActivateMfaTotpDeviceRequest ¶

type ActivateMfaTotpDeviceRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the MFA TOTP device.
	MfaTotpDeviceId *string `mandatory:"true" contributesTo:"path" name:"mfaTotpDeviceId"`

	// MFA TOTP token
	MfaTotpToken `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

ActivateMfaTotpDeviceRequest wrapper for the ActivateMfaTotpDevice operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ActivateMfaTotpDevice.go.html to see an example of how to use ActivateMfaTotpDeviceRequest.

func (ActivateMfaTotpDeviceRequest) BinaryRequestBody ¶

func (request ActivateMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ActivateMfaTotpDeviceRequest) HTTPRequest ¶

func (request ActivateMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ActivateMfaTotpDeviceRequest) RetryPolicy ¶

func (request ActivateMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ActivateMfaTotpDeviceRequest) String ¶

func (request ActivateMfaTotpDeviceRequest) String() string

func (ActivateMfaTotpDeviceRequest) ValidateEnumValue ¶

func (request ActivateMfaTotpDeviceRequest) 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

type ActivateMfaTotpDeviceResponse ¶

type ActivateMfaTotpDeviceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The MfaTotpDeviceSummary instance
	MfaTotpDeviceSummary `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

ActivateMfaTotpDeviceResponse wrapper for the ActivateMfaTotpDevice operation

func (ActivateMfaTotpDeviceResponse) HTTPResponse ¶

func (response ActivateMfaTotpDeviceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ActivateMfaTotpDeviceResponse) String ¶

func (response ActivateMfaTotpDeviceResponse) String() string

type AddLockDetails ¶ added in v65.9.0

type AddLockDetails struct {

	// Type of the lock.
	Type AddLockDetailsTypeEnum `mandatory:"true" json:"type"`

	// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
	RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`

	// A message added by the creator of the lock. This is typically used to give an
	// indication of why the resource is locked.
	Message *string `mandatory:"false" json:"message"`
}

AddLockDetails Request payload to add lock to the resource.

func (AddLockDetails) String ¶ added in v65.9.0

func (m AddLockDetails) String() string

func (AddLockDetails) ValidateEnumValue ¶ added in v65.9.0

func (m AddLockDetails) 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

type AddLockDetailsTypeEnum ¶ added in v65.9.0

type AddLockDetailsTypeEnum string

AddLockDetailsTypeEnum Enum with underlying type: string

const (
	AddLockDetailsTypeFull   AddLockDetailsTypeEnum = "FULL"
	AddLockDetailsTypeDelete AddLockDetailsTypeEnum = "DELETE"
)

Set of constants representing the allowable values for AddLockDetailsTypeEnum

func GetAddLockDetailsTypeEnumValues ¶ added in v65.9.0

func GetAddLockDetailsTypeEnumValues() []AddLockDetailsTypeEnum

GetAddLockDetailsTypeEnumValues Enumerates the set of values for AddLockDetailsTypeEnum

func GetMappingAddLockDetailsTypeEnum ¶ added in v65.9.0

func GetMappingAddLockDetailsTypeEnum(val string) (AddLockDetailsTypeEnum, bool)

GetMappingAddLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type AddTagDefaultLockRequest ¶ added in v65.9.0

type AddTagDefaultLockRequest struct {

	// The OCID of the tag default.
	TagDefaultId *string `mandatory:"true" contributesTo:"path" name:"tagDefaultId"`

	// Lock that is going to be added to resource
	AddLockDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

AddTagDefaultLockRequest wrapper for the AddTagDefaultLock operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddTagDefaultLock.go.html to see an example of how to use AddTagDefaultLockRequest.

func (AddTagDefaultLockRequest) BinaryRequestBody ¶ added in v65.9.0

func (request AddTagDefaultLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AddTagDefaultLockRequest) HTTPRequest ¶ added in v65.9.0

func (request AddTagDefaultLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddTagDefaultLockRequest) RetryPolicy ¶ added in v65.9.0

func (request AddTagDefaultLockRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AddTagDefaultLockRequest) String ¶ added in v65.9.0

func (request AddTagDefaultLockRequest) String() string

func (AddTagDefaultLockRequest) ValidateEnumValue ¶ added in v65.9.0

func (request AddTagDefaultLockRequest) 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

type AddTagDefaultLockResponse ¶ added in v65.9.0

type AddTagDefaultLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagDefault instance
	TagDefault `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

AddTagDefaultLockResponse wrapper for the AddTagDefaultLock operation

func (AddTagDefaultLockResponse) HTTPResponse ¶ added in v65.9.0

func (response AddTagDefaultLockResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AddTagDefaultLockResponse) String ¶ added in v65.9.0

func (response AddTagDefaultLockResponse) String() string

type AddTagNamespaceLockRequest ¶ added in v65.9.0

type AddTagNamespaceLockRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// Lock that is going to be added to resource
	AddLockDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

AddTagNamespaceLockRequest wrapper for the AddTagNamespaceLock operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddTagNamespaceLock.go.html to see an example of how to use AddTagNamespaceLockRequest.

func (AddTagNamespaceLockRequest) BinaryRequestBody ¶ added in v65.9.0

func (request AddTagNamespaceLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AddTagNamespaceLockRequest) HTTPRequest ¶ added in v65.9.0

func (request AddTagNamespaceLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddTagNamespaceLockRequest) RetryPolicy ¶ added in v65.9.0

func (request AddTagNamespaceLockRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AddTagNamespaceLockRequest) String ¶ added in v65.9.0

func (request AddTagNamespaceLockRequest) String() string

func (AddTagNamespaceLockRequest) ValidateEnumValue ¶ added in v65.9.0

func (request AddTagNamespaceLockRequest) 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

type AddTagNamespaceLockResponse ¶ added in v65.9.0

type AddTagNamespaceLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagNamespace instance
	TagNamespace `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

AddTagNamespaceLockResponse wrapper for the AddTagNamespaceLock operation

func (AddTagNamespaceLockResponse) HTTPResponse ¶ added in v65.9.0

func (response AddTagNamespaceLockResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AddTagNamespaceLockResponse) String ¶ added in v65.9.0

func (response AddTagNamespaceLockResponse) String() string

type AddUserToGroupDetails ¶

type AddUserToGroupDetails struct {

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

	// The OCID of the group.
	GroupId *string `mandatory:"true" json:"groupId"`
}

AddUserToGroupDetails The representation of AddUserToGroupDetails

func (AddUserToGroupDetails) String ¶

func (m AddUserToGroupDetails) String() string

func (AddUserToGroupDetails) ValidateEnumValue ¶

func (m AddUserToGroupDetails) 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

type AddUserToGroupRequest ¶

type AddUserToGroupRequest struct {

	// Request object for adding a user to a group.
	AddUserToGroupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

AddUserToGroupRequest wrapper for the AddUserToGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddUserToGroup.go.html to see an example of how to use AddUserToGroupRequest.

func (AddUserToGroupRequest) BinaryRequestBody ¶

func (request AddUserToGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AddUserToGroupRequest) HTTPRequest ¶

func (request AddUserToGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddUserToGroupRequest) RetryPolicy ¶

func (request AddUserToGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AddUserToGroupRequest) String ¶

func (request AddUserToGroupRequest) String() string

func (AddUserToGroupRequest) ValidateEnumValue ¶

func (request AddUserToGroupRequest) 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

type AddUserToGroupResponse ¶

type AddUserToGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The UserGroupMembership instance
	UserGroupMembership `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

AddUserToGroupResponse wrapper for the AddUserToGroup operation

func (AddUserToGroupResponse) HTTPResponse ¶

func (response AddUserToGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AddUserToGroupResponse) String ¶

func (response AddUserToGroupResponse) String() string

type AllowedDomainLicenseTypeSummary ¶

type AllowedDomainLicenseTypeSummary struct {

	// The license type name.
	// Example: "Oracle Apps Premium"
	Name *string `mandatory:"true" json:"name"`

	// The license type identifier.
	// Example: "oracle-apps-premium"
	LicenseType *string `mandatory:"true" json:"licenseType"`

	// The license type description.
	Description *string `mandatory:"true" json:"description"`
}

AllowedDomainLicenseTypeSummary (For tenancies that support identity domains) The 'AllowedDomainLicenseTypeSummary' object contains information about the license type of the identity domain.

func (AllowedDomainLicenseTypeSummary) String ¶

func (AllowedDomainLicenseTypeSummary) ValidateEnumValue ¶

func (m AllowedDomainLicenseTypeSummary) 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

type ApiKey ¶

type ApiKey struct {

	// An Oracle-assigned identifier for the key, in this format:
	// TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.
	KeyId *string `mandatory:"false" json:"keyId"`

	// The key's value.
	KeyValue *string `mandatory:"false" json:"keyValue"`

	// The key's fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).
	Fingerprint *string `mandatory:"false" json:"fingerprint"`

	// The OCID of the user the key belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time the `ApiKey` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The API key's current state. After creating an `ApiKey` object, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState ApiKeyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

ApiKey A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known as an *API signing key*. Specifically, this is the public key from the key pair. The private key remains with the user calling the API. For information about generating a key pair in the required PEM format, see Required Keys and OCIDs (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm). **Important:** This is **not** the SSH key for accessing compute instances. Each user can have a maximum of three API signing keys. For more information about user credentials, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm).

func (ApiKey) String ¶

func (m ApiKey) String() string

func (ApiKey) ValidateEnumValue ¶

func (m ApiKey) 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

type ApiKeyLifecycleStateEnum ¶

type ApiKeyLifecycleStateEnum string

ApiKeyLifecycleStateEnum Enum with underlying type: string

const (
	ApiKeyLifecycleStateCreating ApiKeyLifecycleStateEnum = "CREATING"
	ApiKeyLifecycleStateActive   ApiKeyLifecycleStateEnum = "ACTIVE"
	ApiKeyLifecycleStateInactive ApiKeyLifecycleStateEnum = "INACTIVE"
	ApiKeyLifecycleStateDeleting ApiKeyLifecycleStateEnum = "DELETING"
	ApiKeyLifecycleStateDeleted  ApiKeyLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for ApiKeyLifecycleStateEnum

func GetApiKeyLifecycleStateEnumValues ¶

func GetApiKeyLifecycleStateEnumValues() []ApiKeyLifecycleStateEnum

GetApiKeyLifecycleStateEnumValues Enumerates the set of values for ApiKeyLifecycleStateEnum

func GetMappingApiKeyLifecycleStateEnum ¶

func GetMappingApiKeyLifecycleStateEnum(val string) (ApiKeyLifecycleStateEnum, bool)

GetMappingApiKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type AssembleEffectiveTagSetRequest ¶

type AssembleEffectiveTagSetRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState TagDefaultSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

AssembleEffectiveTagSetRequest wrapper for the AssembleEffectiveTagSet operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AssembleEffectiveTagSet.go.html to see an example of how to use AssembleEffectiveTagSetRequest.

func (AssembleEffectiveTagSetRequest) BinaryRequestBody ¶

func (request AssembleEffectiveTagSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (AssembleEffectiveTagSetRequest) HTTPRequest ¶

func (request AssembleEffectiveTagSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AssembleEffectiveTagSetRequest) RetryPolicy ¶

func (request AssembleEffectiveTagSetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AssembleEffectiveTagSetRequest) String ¶

func (request AssembleEffectiveTagSetRequest) String() string

func (AssembleEffectiveTagSetRequest) ValidateEnumValue ¶

func (request AssembleEffectiveTagSetRequest) 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

type AssembleEffectiveTagSetResponse ¶

type AssembleEffectiveTagSetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []TagDefaultSummary instance
	Items []TagDefaultSummary `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"`

	// For pagination of a list of tag default values. When paging through a list, if this header appears in
	// the response, then a partial list might have been returned. Include this value as the `page` parameter
	// for the subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

AssembleEffectiveTagSetResponse wrapper for the AssembleEffectiveTagSet operation

func (AssembleEffectiveTagSetResponse) HTTPResponse ¶

func (response AssembleEffectiveTagSetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AssembleEffectiveTagSetResponse) String ¶

func (response AssembleEffectiveTagSetResponse) String() string

type AuthToken ¶

type AuthToken struct {

	// The auth token. The value is available only in the response for `CreateAuthToken`, and not
	// for `ListAuthTokens` or `UpdateAuthToken`.
	Token *string `mandatory:"false" json:"token"`

	// The OCID of the auth token.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the auth token belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The description you assign to the auth token. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// Date and time the `AuthToken` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this auth token will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The token's current state. After creating an auth token, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState AuthTokenLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

AuthToken An `AuthToken` is an Oracle-generated token string that you can use to authenticate with third-party APIs that do not support Oracle Cloud Infrastructure's signature-based authentication. For example, use an `AuthToken` to authenticate with a Swift client with the Object Storage Service. The auth token is associated with the user's Console login. Auth tokens never expire. A user can have up to two auth tokens at a time. **Note:** The token is always an Oracle-generated string; you can't change it to a string of your choice. For more information, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).

func (AuthToken) String ¶

func (m AuthToken) String() string

func (AuthToken) ValidateEnumValue ¶

func (m AuthToken) 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

type AuthTokenLifecycleStateEnum ¶

type AuthTokenLifecycleStateEnum string

AuthTokenLifecycleStateEnum Enum with underlying type: string

const (
	AuthTokenLifecycleStateCreating AuthTokenLifecycleStateEnum = "CREATING"
	AuthTokenLifecycleStateActive   AuthTokenLifecycleStateEnum = "ACTIVE"
	AuthTokenLifecycleStateInactive AuthTokenLifecycleStateEnum = "INACTIVE"
	AuthTokenLifecycleStateDeleting AuthTokenLifecycleStateEnum = "DELETING"
	AuthTokenLifecycleStateDeleted  AuthTokenLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for AuthTokenLifecycleStateEnum

func GetAuthTokenLifecycleStateEnumValues ¶

func GetAuthTokenLifecycleStateEnumValues() []AuthTokenLifecycleStateEnum

GetAuthTokenLifecycleStateEnumValues Enumerates the set of values for AuthTokenLifecycleStateEnum

func GetMappingAuthTokenLifecycleStateEnum ¶

func GetMappingAuthTokenLifecycleStateEnum(val string) (AuthTokenLifecycleStateEnum, bool)

GetMappingAuthTokenLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type AuthenticationPolicy ¶

type AuthenticationPolicy struct {
	PasswordPolicy *PasswordPolicy `mandatory:"false" json:"passwordPolicy"`

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

	NetworkPolicy *NetworkPolicy `mandatory:"false" json:"networkPolicy"`
}

AuthenticationPolicy Authentication policy, currently set for the given compartment.

func (AuthenticationPolicy) String ¶

func (m AuthenticationPolicy) String() string

func (AuthenticationPolicy) ValidateEnumValue ¶

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

type AvailabilityDomain ¶

type AvailabilityDomain struct {

	// The name of the Availability Domain.
	Name *string `mandatory:"false" json:"name"`

	// The OCID of the Availability Domain.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the tenancy.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`
}

AvailabilityDomain One or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, and subnets. A region contains several Availability Domains. For more information, see Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).

func (AvailabilityDomain) String ¶

func (m AvailabilityDomain) String() string

func (AvailabilityDomain) ValidateEnumValue ¶

func (m AvailabilityDomain) 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

type BaseTagDefinitionValidator ¶

type BaseTagDefinitionValidator interface {
}

BaseTagDefinitionValidator Validates a definedTag value. Each validator performs validation steps in addition to the standard validation for definedTag values. For more information, see Limits on Tags (https://docs.cloud.oracle.com/Content/Tagging/Concepts/taggingoverview.htm#limits). If you define a validator after a value has been set for a defined tag, then any updates that attempt to change the value must pass the additional validation defined by the current rule. Previously set values (even those that would fail the current validation) are not updated. You can still update other attributes to resources that contain a non-valid defined tag. To clear the validator call UpdateTag with DefaultTagDefinitionValidator (https://docs.cloud.oracle.com/api/#/en/identity/latest/datatypes/DefaultTagDefinitionValidator).

type BaseTagDefinitionValidatorValidatorTypeEnum ¶

type BaseTagDefinitionValidatorValidatorTypeEnum string

BaseTagDefinitionValidatorValidatorTypeEnum Enum with underlying type: string

const (
	BaseTagDefinitionValidatorValidatorTypeEnumvalue BaseTagDefinitionValidatorValidatorTypeEnum = "ENUM"
	BaseTagDefinitionValidatorValidatorTypeDefault   BaseTagDefinitionValidatorValidatorTypeEnum = "DEFAULT"
)

Set of constants representing the allowable values for BaseTagDefinitionValidatorValidatorTypeEnum

func GetBaseTagDefinitionValidatorValidatorTypeEnumValues ¶

func GetBaseTagDefinitionValidatorValidatorTypeEnumValues() []BaseTagDefinitionValidatorValidatorTypeEnum

GetBaseTagDefinitionValidatorValidatorTypeEnumValues Enumerates the set of values for BaseTagDefinitionValidatorValidatorTypeEnum

func GetMappingBaseTagDefinitionValidatorValidatorTypeEnum ¶

func GetMappingBaseTagDefinitionValidatorValidatorTypeEnum(val string) (BaseTagDefinitionValidatorValidatorTypeEnum, bool)

GetMappingBaseTagDefinitionValidatorValidatorTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BulkActionResource ¶

type BulkActionResource struct {

	// The resource OCID.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The resource-type. To get the list of supported resource-types use
	// ListBulkActionResourceTypes.
	EntityType *string `mandatory:"true" json:"entityType"`

	// Additional information that helps to identity the resource for bulk action.
	// The APIs to delete and move most resource types only require the resource identifier (ocid).
	// But some resource-types require additional identifying information.
	// This information is provided in the resource's public API document. It is also
	// available through the
	// ListBulkActionResourceTypes.
	// **Example**:
	// The APIs to delete or move the `buckets` resource-type require `namespaceName` and `bucketName` to identify the resource, as
	// shown in the APIs, DeleteBucket and
	// UpdateBucket.
	// To add a bucket for bulk actions, specify `namespaceName` and `bucketName` in
	// the metadata property as shown in this example
	//     {
	//       "identifier": "<OCID_of_bucket>"
	//       "entityType": "bucket",
	//       "metadata":
	//       {
	//         "namespaceName": "sampleNamespace",
	//         "bucketName": "sampleBucket"
	//       }
	//     }
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

BulkActionResource The bulk action resource entity.

func (BulkActionResource) String ¶

func (m BulkActionResource) String() string

func (BulkActionResource) ValidateEnumValue ¶

func (m BulkActionResource) 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

type BulkActionResourceType ¶

type BulkActionResourceType struct {

	// The unique name of the resource-type.
	Name *string `mandatory:"true" json:"name"`

	// List of metadata keys required to identify a specific resource. Some resource-types require information besides an OCID to identify
	// a specific resource. For example, the resource-type `buckets` requires metadataKeys DeleteBucket.
	MetadataKeys []string `mandatory:"false" json:"metadataKeys"`
}

BulkActionResourceType The representation of BulkActionResourceType

func (BulkActionResourceType) String ¶

func (m BulkActionResourceType) String() string

func (BulkActionResourceType) ValidateEnumValue ¶

func (m BulkActionResourceType) 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

type BulkActionResourceTypeCollection ¶

type BulkActionResourceTypeCollection struct {

	// Collection of the resource-types supported by a compartment bulk action.
	Items []BulkActionResourceType `mandatory:"true" json:"items"`
}

BulkActionResourceTypeCollection Collection of resource-types supported by a compartment bulk action.

func (BulkActionResourceTypeCollection) String ¶

func (BulkActionResourceTypeCollection) ValidateEnumValue ¶

func (m BulkActionResourceTypeCollection) 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

type BulkDeleteResourcesDetails ¶

type BulkDeleteResourcesDetails struct {

	// The resources to be deleted.
	Resources []BulkActionResource `mandatory:"true" json:"resources"`
}

BulkDeleteResourcesDetails The representation of BulkDeleteResourcesDetails

func (BulkDeleteResourcesDetails) String ¶

func (BulkDeleteResourcesDetails) ValidateEnumValue ¶

func (m BulkDeleteResourcesDetails) 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

type BulkDeleteResourcesRequest ¶

type BulkDeleteResourcesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// Request object for bulk delete resources in a compartment.
	BulkDeleteResourcesDetails `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"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

BulkDeleteResourcesRequest wrapper for the BulkDeleteResources operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkDeleteResources.go.html to see an example of how to use BulkDeleteResourcesRequest.

func (BulkDeleteResourcesRequest) BinaryRequestBody ¶

func (request BulkDeleteResourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BulkDeleteResourcesRequest) HTTPRequest ¶

func (request BulkDeleteResourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkDeleteResourcesRequest) RetryPolicy ¶

func (request BulkDeleteResourcesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkDeleteResourcesRequest) String ¶

func (request BulkDeleteResourcesRequest) String() string

func (BulkDeleteResourcesRequest) ValidateEnumValue ¶

func (request BulkDeleteResourcesRequest) 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

type BulkDeleteResourcesResponse ¶

type BulkDeleteResourcesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

BulkDeleteResourcesResponse wrapper for the BulkDeleteResources operation

func (BulkDeleteResourcesResponse) HTTPResponse ¶

func (response BulkDeleteResourcesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkDeleteResourcesResponse) String ¶

func (response BulkDeleteResourcesResponse) String() string

type BulkDeleteTagsDetails ¶

type BulkDeleteTagsDetails struct {

	// The OCIDs of the tag definitions to delete
	TagDefinitionIds []string `mandatory:"true" json:"tagDefinitionIds"`
}

BulkDeleteTagsDetails Properties for deleting tags in bulk

func (BulkDeleteTagsDetails) String ¶

func (m BulkDeleteTagsDetails) String() string

func (BulkDeleteTagsDetails) ValidateEnumValue ¶

func (m BulkDeleteTagsDetails) 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

type BulkDeleteTagsRequest ¶

type BulkDeleteTagsRequest struct {

	// Request object for deleting tags in bulk.
	BulkDeleteTagsDetails `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"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

BulkDeleteTagsRequest wrapper for the BulkDeleteTags operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkDeleteTags.go.html to see an example of how to use BulkDeleteTagsRequest.

func (BulkDeleteTagsRequest) BinaryRequestBody ¶

func (request BulkDeleteTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BulkDeleteTagsRequest) HTTPRequest ¶

func (request BulkDeleteTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkDeleteTagsRequest) RetryPolicy ¶

func (request BulkDeleteTagsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkDeleteTagsRequest) String ¶

func (request BulkDeleteTagsRequest) String() string

func (BulkDeleteTagsRequest) ValidateEnumValue ¶

func (request BulkDeleteTagsRequest) 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

type BulkDeleteTagsResponse ¶

type BulkDeleteTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

BulkDeleteTagsResponse wrapper for the BulkDeleteTags operation

func (BulkDeleteTagsResponse) HTTPResponse ¶

func (response BulkDeleteTagsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkDeleteTagsResponse) String ¶

func (response BulkDeleteTagsResponse) String() string

type BulkEditOperationDetails ¶

type BulkEditOperationDetails struct {

	// An enum-like description of the type of operation.
	// * `ADD_WHERE_ABSENT` adds a defined tag only if the tag does not already exist on the resource.
	// * `SET_WHERE_PRESENT` updates the value for a defined tag only if the tag is present on the resource.
	// * `ADD_OR_SET` combines the first two operations to add a defined tag if it does not already exist on the resource
	// or update the value for a defined tag only if the tag is present on the resource.
	// * `REMOVE` removes the defined tag from the resource. The tag is removed from the resource regardless of the tag value.
	OperationType BulkEditOperationDetailsOperationTypeEnum `mandatory:"true" json:"operationType"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
}

BulkEditOperationDetails The representation of BulkEditOperationDetails

func (BulkEditOperationDetails) String ¶

func (m BulkEditOperationDetails) String() string

func (BulkEditOperationDetails) ValidateEnumValue ¶

func (m BulkEditOperationDetails) 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

type BulkEditOperationDetailsOperationTypeEnum ¶

type BulkEditOperationDetailsOperationTypeEnum string

BulkEditOperationDetailsOperationTypeEnum Enum with underlying type: string

const (
	BulkEditOperationDetailsOperationTypeAddWhereAbsent  BulkEditOperationDetailsOperationTypeEnum = "ADD_WHERE_ABSENT"
	BulkEditOperationDetailsOperationTypeSetWherePresent BulkEditOperationDetailsOperationTypeEnum = "SET_WHERE_PRESENT"
	BulkEditOperationDetailsOperationTypeAddOrSet        BulkEditOperationDetailsOperationTypeEnum = "ADD_OR_SET"
	BulkEditOperationDetailsOperationTypeRemove          BulkEditOperationDetailsOperationTypeEnum = "REMOVE"
)

Set of constants representing the allowable values for BulkEditOperationDetailsOperationTypeEnum

func GetBulkEditOperationDetailsOperationTypeEnumValues ¶

func GetBulkEditOperationDetailsOperationTypeEnumValues() []BulkEditOperationDetailsOperationTypeEnum

GetBulkEditOperationDetailsOperationTypeEnumValues Enumerates the set of values for BulkEditOperationDetailsOperationTypeEnum

func GetMappingBulkEditOperationDetailsOperationTypeEnum ¶

func GetMappingBulkEditOperationDetailsOperationTypeEnum(val string) (BulkEditOperationDetailsOperationTypeEnum, bool)

GetMappingBulkEditOperationDetailsOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BulkEditResource ¶

type BulkEditResource struct {

	// The unique OCID of the resource.
	Id *string `mandatory:"true" json:"id"`

	// The type of resource. See ListBulkEditTagsResourceTypes.
	ResourceType *string `mandatory:"true" json:"resourceType"`

	// Additional information that identifies the resource for bulk editing of tags. This information is provided in the resource's API documentation.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

BulkEditResource The representation of BulkEditResource

func (BulkEditResource) String ¶

func (m BulkEditResource) String() string

func (BulkEditResource) ValidateEnumValue ¶

func (m BulkEditResource) 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

type BulkEditTagsDetails ¶

type BulkEditTagsDetails struct {

	// The OCID of the compartment where the bulk tag edit request is submitted.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources to be updated.
	Resources []BulkEditResource `mandatory:"true" json:"resources"`

	// The operations associated with the request to bulk edit tags.
	BulkEditOperations []BulkEditOperationDetails `mandatory:"true" json:"bulkEditOperations"`
}

BulkEditTagsDetails The representation of BulkEditTagsDetails

func (BulkEditTagsDetails) String ¶

func (m BulkEditTagsDetails) String() string

func (BulkEditTagsDetails) ValidateEnumValue ¶

func (m BulkEditTagsDetails) 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

type BulkEditTagsRequest ¶

type BulkEditTagsRequest struct {

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The request object for bulk editing tags on resources in the compartment.
	BulkEditTagsDetails `contributesTo:"body"`

	// 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
}

BulkEditTagsRequest wrapper for the BulkEditTags operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkEditTags.go.html to see an example of how to use BulkEditTagsRequest.

func (BulkEditTagsRequest) BinaryRequestBody ¶

func (request BulkEditTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BulkEditTagsRequest) HTTPRequest ¶

func (request BulkEditTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkEditTagsRequest) RetryPolicy ¶

func (request BulkEditTagsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkEditTagsRequest) String ¶

func (request BulkEditTagsRequest) String() string

func (BulkEditTagsRequest) ValidateEnumValue ¶

func (request BulkEditTagsRequest) 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

type BulkEditTagsResourceType ¶

type BulkEditTagsResourceType struct {

	// The unique name of the resource type.
	ResourceType *string `mandatory:"true" json:"resourceType"`

	// The metadata keys required to identify the resource.
	// For example, for a bucket, the value of `metadataKeys` will be "namespaceName", "bucketName".
	// This information will match the API documentation.
	// See UpdateBucket (https://docs.cloud.oracle.com/api/#/en/objectstorage/latest/Bucket/UpdateBucket) and
	// DeleteBucket (https://docs.cloud.oracle.com/api/#/en/objectstorage/latest/Bucket/DeleteBucket).
	MetadataKeys []string `mandatory:"false" json:"metadataKeys"`
}

BulkEditTagsResourceType The representation of BulkEditTagsResourceType

func (BulkEditTagsResourceType) String ¶

func (m BulkEditTagsResourceType) String() string

func (BulkEditTagsResourceType) ValidateEnumValue ¶

func (m BulkEditTagsResourceType) 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

type BulkEditTagsResourceTypeCollection ¶

type BulkEditTagsResourceTypeCollection struct {

	// The collection of resource types that support bulk editing of tags.
	Items []BulkEditTagsResourceType `mandatory:"true" json:"items"`
}

BulkEditTagsResourceTypeCollection The list of resource types that support bulk editing of tags.

func (BulkEditTagsResourceTypeCollection) String ¶

func (BulkEditTagsResourceTypeCollection) ValidateEnumValue ¶

func (m BulkEditTagsResourceTypeCollection) 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

type BulkEditTagsResponse ¶

type BulkEditTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

BulkEditTagsResponse wrapper for the BulkEditTags operation

func (BulkEditTagsResponse) HTTPResponse ¶

func (response BulkEditTagsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkEditTagsResponse) String ¶

func (response BulkEditTagsResponse) String() string

type BulkMoveResourcesDetails ¶

type BulkMoveResourcesDetails struct {

	// The resources to be moved.
	Resources []BulkActionResource `mandatory:"true" json:"resources"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the destination compartment
	// into which to move the resources.
	TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`
}

BulkMoveResourcesDetails The representation of BulkMoveResourcesDetails

func (BulkMoveResourcesDetails) String ¶

func (m BulkMoveResourcesDetails) String() string

func (BulkMoveResourcesDetails) ValidateEnumValue ¶

func (m BulkMoveResourcesDetails) 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

type BulkMoveResourcesRequest ¶

type BulkMoveResourcesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// Request object for bulk move resources in the compartment.
	BulkMoveResourcesDetails `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"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

BulkMoveResourcesRequest wrapper for the BulkMoveResources operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkMoveResources.go.html to see an example of how to use BulkMoveResourcesRequest.

func (BulkMoveResourcesRequest) BinaryRequestBody ¶

func (request BulkMoveResourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BulkMoveResourcesRequest) HTTPRequest ¶

func (request BulkMoveResourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkMoveResourcesRequest) RetryPolicy ¶

func (request BulkMoveResourcesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkMoveResourcesRequest) String ¶

func (request BulkMoveResourcesRequest) String() string

func (BulkMoveResourcesRequest) ValidateEnumValue ¶

func (request BulkMoveResourcesRequest) 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

type BulkMoveResourcesResponse ¶

type BulkMoveResourcesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

BulkMoveResourcesResponse wrapper for the BulkMoveResources operation

func (BulkMoveResourcesResponse) HTTPResponse ¶

func (response BulkMoveResourcesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkMoveResourcesResponse) String ¶

func (response BulkMoveResourcesResponse) String() string

type CascadeDeleteTagNamespaceRequest ¶

type CascadeDeleteTagNamespaceRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

CascadeDeleteTagNamespaceRequest wrapper for the CascadeDeleteTagNamespace operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CascadeDeleteTagNamespace.go.html to see an example of how to use CascadeDeleteTagNamespaceRequest.

func (CascadeDeleteTagNamespaceRequest) BinaryRequestBody ¶

func (request CascadeDeleteTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CascadeDeleteTagNamespaceRequest) HTTPRequest ¶

func (request CascadeDeleteTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CascadeDeleteTagNamespaceRequest) RetryPolicy ¶

func (request CascadeDeleteTagNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CascadeDeleteTagNamespaceRequest) String ¶

func (request CascadeDeleteTagNamespaceRequest) String() string

func (CascadeDeleteTagNamespaceRequest) ValidateEnumValue ¶

func (request CascadeDeleteTagNamespaceRequest) 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

type CascadeDeleteTagNamespaceResponse ¶

type CascadeDeleteTagNamespaceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

CascadeDeleteTagNamespaceResponse wrapper for the CascadeDeleteTagNamespace operation

func (CascadeDeleteTagNamespaceResponse) HTTPResponse ¶

func (response CascadeDeleteTagNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CascadeDeleteTagNamespaceResponse) String ¶

func (response CascadeDeleteTagNamespaceResponse) String() string

type ChangeDomainCompartmentDetails ¶

type ChangeDomainCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the destination compartment
	// into which to move the identity domain.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeDomainCompartmentDetails The representation of ChangeDomainCompartmentDetails

func (ChangeDomainCompartmentDetails) String ¶

func (ChangeDomainCompartmentDetails) ValidateEnumValue ¶

func (m ChangeDomainCompartmentDetails) 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

type ChangeDomainCompartmentRequest ¶

type ChangeDomainCompartmentRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

	// The request object for moving the identity domain to a different compartment.
	ChangeDomainCompartmentDetails `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"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

ChangeDomainCompartmentRequest wrapper for the ChangeDomainCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeDomainCompartment.go.html to see an example of how to use ChangeDomainCompartmentRequest.

func (ChangeDomainCompartmentRequest) BinaryRequestBody ¶

func (request ChangeDomainCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeDomainCompartmentRequest) HTTPRequest ¶

func (request ChangeDomainCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeDomainCompartmentRequest) RetryPolicy ¶

func (request ChangeDomainCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeDomainCompartmentRequest) String ¶

func (request ChangeDomainCompartmentRequest) String() string

func (ChangeDomainCompartmentRequest) ValidateEnumValue ¶

func (request ChangeDomainCompartmentRequest) 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

type ChangeDomainCompartmentResponse ¶

type ChangeDomainCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ChangeDomainCompartmentResponse wrapper for the ChangeDomainCompartment operation

func (ChangeDomainCompartmentResponse) HTTPResponse ¶

func (response ChangeDomainCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeDomainCompartmentResponse) String ¶

func (response ChangeDomainCompartmentResponse) String() string

type ChangeDomainLicenseTypeDetails ¶

type ChangeDomainLicenseTypeDetails struct {

	// The license type of the identity domain.
	LicenseType *string `mandatory:"false" json:"licenseType"`
}

ChangeDomainLicenseTypeDetails (For tenancies that support identity domains) Details for updating the license type of the identity domain.

func (ChangeDomainLicenseTypeDetails) String ¶

func (ChangeDomainLicenseTypeDetails) ValidateEnumValue ¶

func (m ChangeDomainLicenseTypeDetails) 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

type ChangeDomainLicenseTypeRequest ¶

type ChangeDomainLicenseTypeRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

	// The request object for an update to the license type of the identity domain.
	ChangeDomainLicenseTypeDetails `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"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

ChangeDomainLicenseTypeRequest wrapper for the ChangeDomainLicenseType operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeDomainLicenseType.go.html to see an example of how to use ChangeDomainLicenseTypeRequest.

func (ChangeDomainLicenseTypeRequest) BinaryRequestBody ¶

func (request ChangeDomainLicenseTypeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeDomainLicenseTypeRequest) HTTPRequest ¶

func (request ChangeDomainLicenseTypeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeDomainLicenseTypeRequest) RetryPolicy ¶

func (request ChangeDomainLicenseTypeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeDomainLicenseTypeRequest) String ¶

func (request ChangeDomainLicenseTypeRequest) String() string

func (ChangeDomainLicenseTypeRequest) ValidateEnumValue ¶

func (request ChangeDomainLicenseTypeRequest) 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

type ChangeDomainLicenseTypeResponse ¶

type ChangeDomainLicenseTypeResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ChangeDomainLicenseTypeResponse wrapper for the ChangeDomainLicenseType operation

func (ChangeDomainLicenseTypeResponse) HTTPResponse ¶

func (response ChangeDomainLicenseTypeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeDomainLicenseTypeResponse) String ¶

func (response ChangeDomainLicenseTypeResponse) String() string

type ChangeTagNamespaceCompartmentDetail ¶

type ChangeTagNamespaceCompartmentDetail struct {

	// The Oracle Cloud ID (OCID) of the destination compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeTagNamespaceCompartmentDetail Details of the compartment the resource is being moved to.

func (ChangeTagNamespaceCompartmentDetail) String ¶

func (ChangeTagNamespaceCompartmentDetail) ValidateEnumValue ¶

func (m ChangeTagNamespaceCompartmentDetail) 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

type ChangeTagNamespaceCompartmentRequest ¶

type ChangeTagNamespaceCompartmentRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// Request object for changing the compartment of a tag namespace.
	ChangeTagNamespaceCompartmentDetail `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

ChangeTagNamespaceCompartmentRequest wrapper for the ChangeTagNamespaceCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeTagNamespaceCompartment.go.html to see an example of how to use ChangeTagNamespaceCompartmentRequest.

func (ChangeTagNamespaceCompartmentRequest) BinaryRequestBody ¶

func (request ChangeTagNamespaceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeTagNamespaceCompartmentRequest) HTTPRequest ¶

func (request ChangeTagNamespaceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeTagNamespaceCompartmentRequest) RetryPolicy ¶

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeTagNamespaceCompartmentRequest) String ¶

func (ChangeTagNamespaceCompartmentRequest) ValidateEnumValue ¶

func (request ChangeTagNamespaceCompartmentRequest) 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

type ChangeTagNamespaceCompartmentResponse ¶

type ChangeTagNamespaceCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

ChangeTagNamespaceCompartmentResponse wrapper for the ChangeTagNamespaceCompartment operation

func (ChangeTagNamespaceCompartmentResponse) HTTPResponse ¶

func (response ChangeTagNamespaceCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeTagNamespaceCompartmentResponse) String ¶

type ChangeTasDomainLicenseTypeDetails ¶

type ChangeTasDomainLicenseTypeDetails struct {

	// The license type of the identity domain.
	LicenseType *string `mandatory:"false" json:"licenseType"`
}

ChangeTasDomainLicenseTypeDetails (For tenancies that support identity domains) Update the identity domain license type.

func (ChangeTasDomainLicenseTypeDetails) String ¶

func (ChangeTasDomainLicenseTypeDetails) ValidateEnumValue ¶

func (m ChangeTasDomainLicenseTypeDetails) 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

type Compartment ¶

type Compartment struct {

	// The OCID of the compartment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the parent compartment containing the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the compartment during creation. The name must be unique across all
	// compartments in the parent. Avoid entering confidential information.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the compartment. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// Date and time the compartment was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The compartment's current state. After creating a compartment, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState CompartmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Indicates whether or not the compartment is accessible for the user making the request.
	// Returns true when the user has INSPECT permissions directly on a resource in the
	// compartment or indirectly (permissions can be on a resource in a subcompartment).
	IsAccessible *bool `mandatory:"false" json:"isAccessible"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Compartment A collection of related resources. Compartments are a fundamental component of Oracle Cloud Infrastructure for organizing and isolating your cloud resources. You use them to clearly separate resources for the purposes of measuring usage and billing, access (through the use of IAM Service policies), and isolation (separating the resources for one project or business unit from another). A common approach is to create a compartment for each major part of your organization. For more information, see Overview of IAM (https://docs.cloud.oracle.com//Content/Identity/getstarted/identity-domains.htm) and also Setting Up Your Tenancy (https://docs.cloud.oracle.com/Content/GSG/Concepts/settinguptenancy.htm). To place a resource in a compartment, simply specify the compartment ID in the "Create" request object when initially creating the resource. For example, to launch an instance into a particular compartment, specify that compartment's OCID in the `LaunchInstance` request. You can't move an existing resource from one compartment to another. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Compartment) String ¶

func (m Compartment) String() string

func (Compartment) ValidateEnumValue ¶

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

type CompartmentLifecycleStateEnum ¶

type CompartmentLifecycleStateEnum string

CompartmentLifecycleStateEnum Enum with underlying type: string

const (
	CompartmentLifecycleStateCreating CompartmentLifecycleStateEnum = "CREATING"
	CompartmentLifecycleStateActive   CompartmentLifecycleStateEnum = "ACTIVE"
	CompartmentLifecycleStateInactive CompartmentLifecycleStateEnum = "INACTIVE"
	CompartmentLifecycleStateDeleting CompartmentLifecycleStateEnum = "DELETING"
	CompartmentLifecycleStateDeleted  CompartmentLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for CompartmentLifecycleStateEnum

func GetCompartmentLifecycleStateEnumValues ¶

func GetCompartmentLifecycleStateEnumValues() []CompartmentLifecycleStateEnum

GetCompartmentLifecycleStateEnumValues Enumerates the set of values for CompartmentLifecycleStateEnum

func GetMappingCompartmentLifecycleStateEnum ¶

func GetMappingCompartmentLifecycleStateEnum(val string) (CompartmentLifecycleStateEnum, bool)

GetMappingCompartmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateApiKeyDetails ¶

type CreateApiKeyDetails struct {

	// The public key.  Must be an RSA key in PEM format.
	Key *string `mandatory:"true" json:"key"`
}

CreateApiKeyDetails The representation of CreateApiKeyDetails

func (CreateApiKeyDetails) String ¶

func (m CreateApiKeyDetails) String() string

func (CreateApiKeyDetails) ValidateEnumValue ¶

func (m CreateApiKeyDetails) 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

type CreateAuthTokenDetails ¶

type CreateAuthTokenDetails struct {

	// The description you assign to the auth token during creation. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`
}

CreateAuthTokenDetails The representation of CreateAuthTokenDetails

func (CreateAuthTokenDetails) String ¶

func (m CreateAuthTokenDetails) String() string

func (CreateAuthTokenDetails) ValidateEnumValue ¶

func (m CreateAuthTokenDetails) 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

type CreateAuthTokenRequest ¶

type CreateAuthTokenRequest struct {

	// Request object for creating a new auth token.
	CreateAuthTokenDetails `contributesTo:"body"`

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateAuthTokenRequest wrapper for the CreateAuthToken operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateAuthToken.go.html to see an example of how to use CreateAuthTokenRequest.

func (CreateAuthTokenRequest) BinaryRequestBody ¶

func (request CreateAuthTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAuthTokenRequest) HTTPRequest ¶

func (request CreateAuthTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAuthTokenRequest) RetryPolicy ¶

func (request CreateAuthTokenRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAuthTokenRequest) String ¶

func (request CreateAuthTokenRequest) String() string

func (CreateAuthTokenRequest) ValidateEnumValue ¶

func (request CreateAuthTokenRequest) 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

type CreateAuthTokenResponse ¶

type CreateAuthTokenResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AuthToken instance
	AuthToken `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateAuthTokenResponse wrapper for the CreateAuthToken operation

func (CreateAuthTokenResponse) HTTPResponse ¶

func (response CreateAuthTokenResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAuthTokenResponse) String ¶

func (response CreateAuthTokenResponse) String() string

type CreateCompartmentDetails ¶

type CreateCompartmentDetails struct {

	// The OCID of the parent compartment containing the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the compartment during creation. The name must be unique across all compartments
	// in the parent compartment. Avoid entering confidential information.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the compartment during creation. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateCompartmentDetails The representation of CreateCompartmentDetails

func (CreateCompartmentDetails) String ¶

func (m CreateCompartmentDetails) String() string

func (CreateCompartmentDetails) ValidateEnumValue ¶

func (m CreateCompartmentDetails) 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

type CreateCompartmentRequest ¶

type CreateCompartmentRequest struct {

	// Request object for creating a new compartment.
	CreateCompartmentDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateCompartmentRequest wrapper for the CreateCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateCompartment.go.html to see an example of how to use CreateCompartmentRequest.

func (CreateCompartmentRequest) BinaryRequestBody ¶

func (request CreateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateCompartmentRequest) HTTPRequest ¶

func (request CreateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCompartmentRequest) RetryPolicy ¶

func (request CreateCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCompartmentRequest) String ¶

func (request CreateCompartmentRequest) String() string

func (CreateCompartmentRequest) ValidateEnumValue ¶

func (request CreateCompartmentRequest) 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

type CreateCompartmentResponse ¶

type CreateCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Compartment instance
	Compartment `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateCompartmentResponse wrapper for the CreateCompartment operation

func (CreateCompartmentResponse) HTTPResponse ¶

func (response CreateCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCompartmentResponse) String ¶

func (response CreateCompartmentResponse) String() string

type CreateCustomerSecretKeyDetails ¶

type CreateCustomerSecretKeyDetails struct {

	// The name you assign to the secret key during creation. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`
}

CreateCustomerSecretKeyDetails The representation of CreateCustomerSecretKeyDetails

func (CreateCustomerSecretKeyDetails) String ¶

func (CreateCustomerSecretKeyDetails) ValidateEnumValue ¶

func (m CreateCustomerSecretKeyDetails) 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

type CreateCustomerSecretKeyRequest ¶

type CreateCustomerSecretKeyRequest struct {

	// Request object for creating a new secret key.
	CreateCustomerSecretKeyDetails `contributesTo:"body"`

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateCustomerSecretKeyRequest wrapper for the CreateCustomerSecretKey operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateCustomerSecretKey.go.html to see an example of how to use CreateCustomerSecretKeyRequest.

func (CreateCustomerSecretKeyRequest) BinaryRequestBody ¶

func (request CreateCustomerSecretKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateCustomerSecretKeyRequest) HTTPRequest ¶

func (request CreateCustomerSecretKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCustomerSecretKeyRequest) RetryPolicy ¶

func (request CreateCustomerSecretKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCustomerSecretKeyRequest) String ¶

func (request CreateCustomerSecretKeyRequest) String() string

func (CreateCustomerSecretKeyRequest) ValidateEnumValue ¶

func (request CreateCustomerSecretKeyRequest) 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

type CreateCustomerSecretKeyResponse ¶

type CreateCustomerSecretKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CustomerSecretKey instance
	CustomerSecretKey `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateCustomerSecretKeyResponse wrapper for the CreateCustomerSecretKey operation

func (CreateCustomerSecretKeyResponse) HTTPResponse ¶

func (response CreateCustomerSecretKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCustomerSecretKeyResponse) String ¶

func (response CreateCustomerSecretKeyResponse) String() string

type CreateDbCredentialDetails ¶

type CreateDbCredentialDetails struct {

	// The password for the DB credentials during creation.
	Password *string `mandatory:"true" json:"password"`

	// The description you assign to the DB credentials during creation.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`
}

CreateDbCredentialDetails The representation of CreateDbCredentialDetails

func (CreateDbCredentialDetails) String ¶

func (m CreateDbCredentialDetails) String() string

func (CreateDbCredentialDetails) ValidateEnumValue ¶

func (m CreateDbCredentialDetails) 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

type CreateDbCredentialRequest ¶

type CreateDbCredentialRequest struct {

	// Request object for creating a new DB credential with the user.
	CreateDbCredentialDetails `contributesTo:"body"`

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateDbCredentialRequest wrapper for the CreateDbCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDbCredential.go.html to see an example of how to use CreateDbCredentialRequest.

func (CreateDbCredentialRequest) BinaryRequestBody ¶

func (request CreateDbCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDbCredentialRequest) HTTPRequest ¶

func (request CreateDbCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDbCredentialRequest) RetryPolicy ¶

func (request CreateDbCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDbCredentialRequest) String ¶

func (request CreateDbCredentialRequest) String() string

func (CreateDbCredentialRequest) ValidateEnumValue ¶

func (request CreateDbCredentialRequest) 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

type CreateDbCredentialResponse ¶

type CreateDbCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DbCredential instance
	DbCredential `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateDbCredentialResponse wrapper for the CreateDbCredential operation

func (CreateDbCredentialResponse) HTTPResponse ¶

func (response CreateDbCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDbCredentialResponse) String ¶

func (response CreateDbCredentialResponse) String() string

type CreateDomainDetails ¶

type CreateDomainDetails struct {

	// The OCID of the compartment where the identity domain is created.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The mutable display name of the identity domain.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The identity domain description. You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// The region's name identifier. See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported region names.
	// Example: `us-phoenix-1`
	HomeRegion *string `mandatory:"true" json:"homeRegion"`

	// The license type of the identity domain.
	LicenseType *string `mandatory:"true" json:"licenseType"`

	// Indicates whether the identity domain is hidden on the sign-in screen or not.
	IsHiddenOnLogin *bool `mandatory:"false" json:"isHiddenOnLogin"`

	// The administrator's first name.
	AdminFirstName *string `mandatory:"false" json:"adminFirstName"`

	// The administrator's last name.
	AdminLastName *string `mandatory:"false" json:"adminLastName"`

	// The administrator's user name.
	AdminUserName *string `mandatory:"false" json:"adminUserName"`

	// The administrator's email address.
	AdminEmail *string `mandatory:"false" json:"adminEmail"`

	// Indicates whether or not the administrator user created in the IDCS stripe would like to receive notifications like a welcome email.
	// This field is required only if admin information is provided. This field is otherwise optional.
	IsNotificationBypassed *bool `mandatory:"false" json:"isNotificationBypassed"`

	// Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true.
	IsPrimaryEmailRequired *bool `mandatory:"false" json:"isPrimaryEmailRequired"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDomainDetails (For tenancies that support identity domains) Details for creating an identity domain.

func (CreateDomainDetails) String ¶

func (m CreateDomainDetails) String() string

func (CreateDomainDetails) ValidateEnumValue ¶

func (m CreateDomainDetails) 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

type CreateDomainRequest ¶

type CreateDomainRequest struct {

	// The request object for creating a new identity domain.
	CreateDomainDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateDomainRequest wrapper for the CreateDomain operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDomain.go.html to see an example of how to use CreateDomainRequest.

func (CreateDomainRequest) BinaryRequestBody ¶

func (request CreateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDomainRequest) HTTPRequest ¶

func (request CreateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDomainRequest) RetryPolicy ¶

func (request CreateDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDomainRequest) String ¶

func (request CreateDomainRequest) String() string

func (CreateDomainRequest) ValidateEnumValue ¶

func (request CreateDomainRequest) 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

type CreateDomainResponse ¶

type CreateDomainResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

CreateDomainResponse wrapper for the CreateDomain operation

func (CreateDomainResponse) HTTPResponse ¶

func (response CreateDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDomainResponse) String ¶

func (response CreateDomainResponse) String() string

type CreateDynamicGroupDetails ¶

type CreateDynamicGroupDetails struct {

	// The OCID of the tenancy containing the group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the group during creation. The name must be unique across all groups
	// in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The matching rule to dynamically match an instance certificate to this dynamic group.
	// For rule syntax, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/dynamicgroups/managingdynamicgroups.htm).
	MatchingRule *string `mandatory:"true" json:"matchingRule"`

	// The description you assign to the group during creation. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDynamicGroupDetails Properties for creating a dynamic group.

func (CreateDynamicGroupDetails) String ¶

func (m CreateDynamicGroupDetails) String() string

func (CreateDynamicGroupDetails) ValidateEnumValue ¶

func (m CreateDynamicGroupDetails) 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

type CreateDynamicGroupRequest ¶

type CreateDynamicGroupRequest struct {

	// Request object for creating a new dynamic group.
	CreateDynamicGroupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateDynamicGroupRequest wrapper for the CreateDynamicGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDynamicGroup.go.html to see an example of how to use CreateDynamicGroupRequest.

func (CreateDynamicGroupRequest) BinaryRequestBody ¶

func (request CreateDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDynamicGroupRequest) HTTPRequest ¶

func (request CreateDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDynamicGroupRequest) RetryPolicy ¶

func (request CreateDynamicGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDynamicGroupRequest) String ¶

func (request CreateDynamicGroupRequest) String() string

func (CreateDynamicGroupRequest) ValidateEnumValue ¶

func (request CreateDynamicGroupRequest) 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

type CreateDynamicGroupResponse ¶

type CreateDynamicGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DynamicGroup instance
	DynamicGroup `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateDynamicGroupResponse wrapper for the CreateDynamicGroup operation

func (CreateDynamicGroupResponse) HTTPResponse ¶

func (response CreateDynamicGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDynamicGroupResponse) String ¶

func (response CreateDynamicGroupResponse) String() string

type CreateGroupDetails ¶

type CreateGroupDetails struct {

	// The OCID of the tenancy containing the group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the group during creation. The name must be unique across all groups
	// in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the group during creation. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateGroupDetails The representation of CreateGroupDetails

func (CreateGroupDetails) String ¶

func (m CreateGroupDetails) String() string

func (CreateGroupDetails) ValidateEnumValue ¶

func (m CreateGroupDetails) 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

type CreateGroupRequest ¶

type CreateGroupRequest struct {

	// Request object for creating a new group.
	CreateGroupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateGroupRequest wrapper for the CreateGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateGroup.go.html to see an example of how to use CreateGroupRequest.

func (CreateGroupRequest) BinaryRequestBody ¶

func (request CreateGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateGroupRequest) HTTPRequest ¶

func (request CreateGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateGroupRequest) RetryPolicy ¶

func (request CreateGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateGroupRequest) String ¶

func (request CreateGroupRequest) String() string

func (CreateGroupRequest) ValidateEnumValue ¶

func (request CreateGroupRequest) 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

type CreateGroupResponse ¶

type CreateGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Group instance
	Group `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateGroupResponse wrapper for the CreateGroup operation

func (CreateGroupResponse) HTTPResponse ¶

func (response CreateGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateGroupResponse) String ¶

func (response CreateGroupResponse) String() string

type CreateIdentityProviderDetails ¶

type CreateIdentityProviderDetails interface {

	// The OCID of your tenancy.
	GetCompartmentId() *string

	// The name you assign to the `IdentityProvider` during creation.
	// The name must be unique across all `IdentityProvider` objects in the
	// tenancy and cannot be changed.
	GetName() *string

	// The description you assign to the `IdentityProvider` during creation.
	// Does not have to be unique, and it's changeable.
	GetDescription() *string

	// The identity provider service or product.
	// Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft
	// Active Directory Federation Services (ADFS).
	// Example: `IDCS`
	GetProductType() CreateIdentityProviderDetailsProductTypeEnum

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

CreateIdentityProviderDetails The representation of CreateIdentityProviderDetails

type CreateIdentityProviderDetailsProductTypeEnum ¶

type CreateIdentityProviderDetailsProductTypeEnum string

CreateIdentityProviderDetailsProductTypeEnum Enum with underlying type: string

const (
	CreateIdentityProviderDetailsProductTypeIdcs CreateIdentityProviderDetailsProductTypeEnum = "IDCS"
	CreateIdentityProviderDetailsProductTypeAdfs CreateIdentityProviderDetailsProductTypeEnum = "ADFS"
)

Set of constants representing the allowable values for CreateIdentityProviderDetailsProductTypeEnum

func GetCreateIdentityProviderDetailsProductTypeEnumValues ¶

func GetCreateIdentityProviderDetailsProductTypeEnumValues() []CreateIdentityProviderDetailsProductTypeEnum

GetCreateIdentityProviderDetailsProductTypeEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProductTypeEnum

func GetMappingCreateIdentityProviderDetailsProductTypeEnum ¶

func GetMappingCreateIdentityProviderDetailsProductTypeEnum(val string) (CreateIdentityProviderDetailsProductTypeEnum, bool)

GetMappingCreateIdentityProviderDetailsProductTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateIdentityProviderDetailsProtocolEnum ¶

type CreateIdentityProviderDetailsProtocolEnum string

CreateIdentityProviderDetailsProtocolEnum Enum with underlying type: string

const (
	CreateIdentityProviderDetailsProtocolSaml2 CreateIdentityProviderDetailsProtocolEnum = "SAML2"
	CreateIdentityProviderDetailsProtocolAdfs  CreateIdentityProviderDetailsProtocolEnum = "ADFS"
)

Set of constants representing the allowable values for CreateIdentityProviderDetailsProtocolEnum

func GetCreateIdentityProviderDetailsProtocolEnumValues ¶

func GetCreateIdentityProviderDetailsProtocolEnumValues() []CreateIdentityProviderDetailsProtocolEnum

GetCreateIdentityProviderDetailsProtocolEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProtocolEnum

func GetMappingCreateIdentityProviderDetailsProtocolEnum ¶

func GetMappingCreateIdentityProviderDetailsProtocolEnum(val string) (CreateIdentityProviderDetailsProtocolEnum, bool)

GetMappingCreateIdentityProviderDetailsProtocolEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateIdentityProviderRequest ¶

type CreateIdentityProviderRequest struct {

	// Request object for creating a new SAML2 identity provider.
	CreateIdentityProviderDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateIdentityProviderRequest wrapper for the CreateIdentityProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateIdentityProvider.go.html to see an example of how to use CreateIdentityProviderRequest.

func (CreateIdentityProviderRequest) BinaryRequestBody ¶

func (request CreateIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateIdentityProviderRequest) HTTPRequest ¶

func (request CreateIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIdentityProviderRequest) RetryPolicy ¶

func (request CreateIdentityProviderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateIdentityProviderRequest) String ¶

func (request CreateIdentityProviderRequest) String() string

func (CreateIdentityProviderRequest) ValidateEnumValue ¶

func (request CreateIdentityProviderRequest) 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

type CreateIdentityProviderResponse ¶

type CreateIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IdentityProvider instance
	IdentityProvider `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateIdentityProviderResponse wrapper for the CreateIdentityProvider operation

func (CreateIdentityProviderResponse) HTTPResponse ¶

func (response CreateIdentityProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateIdentityProviderResponse) String ¶

func (response CreateIdentityProviderResponse) String() string

type CreateIdpGroupMappingDetails ¶

type CreateIdpGroupMappingDetails struct {

	// The name of the IdP group you want to map.
	IdpGroupName *string `mandatory:"true" json:"idpGroupName"`

	// The OCID of the IAM Service Group
	// you want to map to the IdP group.
	GroupId *string `mandatory:"true" json:"groupId"`
}

CreateIdpGroupMappingDetails The representation of CreateIdpGroupMappingDetails

func (CreateIdpGroupMappingDetails) String ¶

func (CreateIdpGroupMappingDetails) ValidateEnumValue ¶

func (m CreateIdpGroupMappingDetails) 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

type CreateIdpGroupMappingRequest ¶

type CreateIdpGroupMappingRequest struct {

	// Add a mapping from an SAML2.0 identity provider group to a BMC group.
	CreateIdpGroupMappingDetails `contributesTo:"body"`

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateIdpGroupMappingRequest wrapper for the CreateIdpGroupMapping operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateIdpGroupMapping.go.html to see an example of how to use CreateIdpGroupMappingRequest.

func (CreateIdpGroupMappingRequest) BinaryRequestBody ¶

func (request CreateIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateIdpGroupMappingRequest) HTTPRequest ¶

func (request CreateIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIdpGroupMappingRequest) RetryPolicy ¶

func (request CreateIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateIdpGroupMappingRequest) String ¶

func (request CreateIdpGroupMappingRequest) String() string

func (CreateIdpGroupMappingRequest) ValidateEnumValue ¶

func (request CreateIdpGroupMappingRequest) 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

type CreateIdpGroupMappingResponse ¶

type CreateIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IdpGroupMapping instance
	IdpGroupMapping `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateIdpGroupMappingResponse wrapper for the CreateIdpGroupMapping operation

func (CreateIdpGroupMappingResponse) HTTPResponse ¶

func (response CreateIdpGroupMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateIdpGroupMappingResponse) String ¶

func (response CreateIdpGroupMappingResponse) String() string

type CreateMfaTotpDeviceRequest ¶

type CreateMfaTotpDeviceRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateMfaTotpDeviceRequest wrapper for the CreateMfaTotpDevice operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateMfaTotpDevice.go.html to see an example of how to use CreateMfaTotpDeviceRequest.

func (CreateMfaTotpDeviceRequest) BinaryRequestBody ¶

func (request CreateMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateMfaTotpDeviceRequest) HTTPRequest ¶

func (request CreateMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateMfaTotpDeviceRequest) RetryPolicy ¶

func (request CreateMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateMfaTotpDeviceRequest) String ¶

func (request CreateMfaTotpDeviceRequest) String() string

func (CreateMfaTotpDeviceRequest) ValidateEnumValue ¶

func (request CreateMfaTotpDeviceRequest) 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

type CreateMfaTotpDeviceResponse ¶

type CreateMfaTotpDeviceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The MfaTotpDevice instance
	MfaTotpDevice `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateMfaTotpDeviceResponse wrapper for the CreateMfaTotpDevice operation

func (CreateMfaTotpDeviceResponse) HTTPResponse ¶

func (response CreateMfaTotpDeviceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateMfaTotpDeviceResponse) String ¶

func (response CreateMfaTotpDeviceResponse) String() string

type CreateNetworkSourceDetails ¶

type CreateNetworkSourceDetails struct {

	// The OCID of the tenancy (root compartment) containing the network source object.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the network source during creation. The name must be unique across all groups
	// in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the network source during creation. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// A list of allowed public IP addresses and CIDR ranges.
	PublicSourceList []string `mandatory:"false" json:"publicSourceList"`

	// A list of allowed VCN OCID and IP range pairs.
	// Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]`
	VirtualSourceList []NetworkSourcesVirtualSourceList `mandatory:"false" json:"virtualSourceList"`

	// -- The services attribute has no effect and is reserved for use by Oracle. --
	Services []string `mandatory:"false" json:"services"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateNetworkSourceDetails Properties for creating a network source object.

func (CreateNetworkSourceDetails) String ¶

func (CreateNetworkSourceDetails) ValidateEnumValue ¶

func (m CreateNetworkSourceDetails) 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

type CreateNetworkSourceRequest ¶

type CreateNetworkSourceRequest struct {

	// Request object for creating a new network source.
	CreateNetworkSourceDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateNetworkSourceRequest wrapper for the CreateNetworkSource operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateNetworkSource.go.html to see an example of how to use CreateNetworkSourceRequest.

func (CreateNetworkSourceRequest) BinaryRequestBody ¶

func (request CreateNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateNetworkSourceRequest) HTTPRequest ¶

func (request CreateNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateNetworkSourceRequest) RetryPolicy ¶

func (request CreateNetworkSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateNetworkSourceRequest) String ¶

func (request CreateNetworkSourceRequest) String() string

func (CreateNetworkSourceRequest) ValidateEnumValue ¶

func (request CreateNetworkSourceRequest) 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

type CreateNetworkSourceResponse ¶

type CreateNetworkSourceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The NetworkSources instance
	NetworkSources `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateNetworkSourceResponse wrapper for the CreateNetworkSource operation

func (CreateNetworkSourceResponse) HTTPResponse ¶

func (response CreateNetworkSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateNetworkSourceResponse) String ¶

func (response CreateNetworkSourceResponse) String() string

type CreateOAuth2ClientCredentialDetails ¶

type CreateOAuth2ClientCredentialDetails struct {

	// Name of the oauth credential to help user differentiate them.
	Name *string `mandatory:"true" json:"name"`

	// Description of the oauth credential to help user differentiate them.
	Description *string `mandatory:"true" json:"description"`

	// Allowed scopes for the given oauth credential.
	Scopes []FullyQualifiedScope `mandatory:"true" json:"scopes"`
}

CreateOAuth2ClientCredentialDetails The representation of CreateOAuth2ClientCredentialDetails

func (CreateOAuth2ClientCredentialDetails) String ¶

func (CreateOAuth2ClientCredentialDetails) ValidateEnumValue ¶

func (m CreateOAuth2ClientCredentialDetails) 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

type CreateOAuthClientCredentialRequest ¶

type CreateOAuthClientCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object containing the information required to generate an Oauth token.
	CreateOAuth2ClientCredentialDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateOAuthClientCredentialRequest wrapper for the CreateOAuthClientCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateOAuthClientCredential.go.html to see an example of how to use CreateOAuthClientCredentialRequest.

func (CreateOAuthClientCredentialRequest) BinaryRequestBody ¶

func (request CreateOAuthClientCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateOAuthClientCredentialRequest) HTTPRequest ¶

func (request CreateOAuthClientCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOAuthClientCredentialRequest) RetryPolicy ¶

func (request CreateOAuthClientCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOAuthClientCredentialRequest) String ¶

func (request CreateOAuthClientCredentialRequest) String() string

func (CreateOAuthClientCredentialRequest) ValidateEnumValue ¶

func (request CreateOAuthClientCredentialRequest) 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

type CreateOAuthClientCredentialResponse ¶

type CreateOAuthClientCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OAuth2ClientCredential instance
	OAuth2ClientCredential `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateOAuthClientCredentialResponse wrapper for the CreateOAuthClientCredential operation

func (CreateOAuthClientCredentialResponse) HTTPResponse ¶

func (response CreateOAuthClientCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOAuthClientCredentialResponse) String ¶

func (response CreateOAuthClientCredentialResponse) String() string

type CreateOrResetUIPasswordRequest ¶

type CreateOrResetUIPasswordRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateOrResetUIPasswordRequest wrapper for the CreateOrResetUIPassword operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateOrResetUIPassword.go.html to see an example of how to use CreateOrResetUIPasswordRequest.

func (CreateOrResetUIPasswordRequest) BinaryRequestBody ¶

func (request CreateOrResetUIPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateOrResetUIPasswordRequest) HTTPRequest ¶

func (request CreateOrResetUIPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOrResetUIPasswordRequest) RetryPolicy ¶

func (request CreateOrResetUIPasswordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOrResetUIPasswordRequest) String ¶

func (request CreateOrResetUIPasswordRequest) String() string

func (CreateOrResetUIPasswordRequest) ValidateEnumValue ¶

func (request CreateOrResetUIPasswordRequest) 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

type CreateOrResetUIPasswordResponse ¶

type CreateOrResetUIPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The UiPassword instance
	UiPassword `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateOrResetUIPasswordResponse wrapper for the CreateOrResetUIPassword operation

func (CreateOrResetUIPasswordResponse) HTTPResponse ¶

func (response CreateOrResetUIPasswordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOrResetUIPasswordResponse) String ¶

func (response CreateOrResetUIPasswordResponse) String() string

type CreatePolicyDetails ¶

type CreatePolicyDetails struct {

	// The OCID of the compartment containing the policy (either the tenancy or another compartment).
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the policy during creation. The name must be unique across all policies
	// in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// An array of policy statements written in the policy language. See
	// How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm) and
	// Common Policies (https://docs.cloud.oracle.com/Content/Identity/policiescommon/commonpolicies.htm).
	Statements []string `mandatory:"true" json:"statements"`

	// The description you assign to the policy during creation. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// The version of the policy. If null or set to an empty string, when a request comes in for authorization, the
	// policy will be evaluated according to the current behavior of the services at that moment. If set to a particular
	// date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.
	VersionDate *common.SDKDate `mandatory:"false" json:"versionDate"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreatePolicyDetails The representation of CreatePolicyDetails

func (CreatePolicyDetails) String ¶

func (m CreatePolicyDetails) String() string

func (CreatePolicyDetails) ValidateEnumValue ¶

func (m CreatePolicyDetails) 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

type CreatePolicyRequest ¶

type CreatePolicyRequest struct {

	// Request object for creating a new policy.
	CreatePolicyDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreatePolicyRequest wrapper for the CreatePolicy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreatePolicy.go.html to see an example of how to use CreatePolicyRequest.

func (CreatePolicyRequest) BinaryRequestBody ¶

func (request CreatePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreatePolicyRequest) HTTPRequest ¶

func (request CreatePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePolicyRequest) RetryPolicy ¶

func (request CreatePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreatePolicyRequest) String ¶

func (request CreatePolicyRequest) String() string

func (CreatePolicyRequest) ValidateEnumValue ¶

func (request CreatePolicyRequest) 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

type CreatePolicyResponse ¶

type CreatePolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Policy instance
	Policy `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreatePolicyResponse wrapper for the CreatePolicy operation

func (CreatePolicyResponse) HTTPResponse ¶

func (response CreatePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreatePolicyResponse) String ¶

func (response CreatePolicyResponse) String() string

type CreateRegionSubscriptionDetails ¶

type CreateRegionSubscriptionDetails struct {

	// The regions's key. See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for
	// the full list of supported 3-letter region codes.
	// Example: `PHX`
	RegionKey *string `mandatory:"true" json:"regionKey"`
}

CreateRegionSubscriptionDetails The representation of CreateRegionSubscriptionDetails

func (CreateRegionSubscriptionDetails) String ¶

func (CreateRegionSubscriptionDetails) ValidateEnumValue ¶

func (m CreateRegionSubscriptionDetails) 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

type CreateRegionSubscriptionRequest ¶

type CreateRegionSubscriptionRequest struct {

	// Request object for activate a new region.
	CreateRegionSubscriptionDetails `contributesTo:"body"`

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"path" name:"tenancyId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateRegionSubscriptionRequest wrapper for the CreateRegionSubscription operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateRegionSubscription.go.html to see an example of how to use CreateRegionSubscriptionRequest.

func (CreateRegionSubscriptionRequest) BinaryRequestBody ¶

func (request CreateRegionSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateRegionSubscriptionRequest) HTTPRequest ¶

func (request CreateRegionSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRegionSubscriptionRequest) RetryPolicy ¶

func (request CreateRegionSubscriptionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateRegionSubscriptionRequest) String ¶

func (request CreateRegionSubscriptionRequest) String() string

func (CreateRegionSubscriptionRequest) ValidateEnumValue ¶

func (request CreateRegionSubscriptionRequest) 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

type CreateRegionSubscriptionResponse ¶

type CreateRegionSubscriptionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RegionSubscription instance
	RegionSubscription `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"`
}

CreateRegionSubscriptionResponse wrapper for the CreateRegionSubscription operation

func (CreateRegionSubscriptionResponse) HTTPResponse ¶

func (response CreateRegionSubscriptionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateRegionSubscriptionResponse) String ¶

func (response CreateRegionSubscriptionResponse) String() string

type CreateSaml2IdentityProviderDetails ¶

type CreateSaml2IdentityProviderDetails struct {

	// The OCID of your tenancy.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the `IdentityProvider` during creation.
	// The name must be unique across all `IdentityProvider` objects in the
	// tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the `IdentityProvider` during creation.
	// Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// The URL for retrieving the identity provider's metadata,
	// which contains information required for federating.
	MetadataUrl *string `mandatory:"true" json:"metadataUrl"`

	// The XML that contains the information required for federating.
	Metadata *string `mandatory:"true" json:"metadata"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Extra name value pairs associated with this identity provider.
	// Example: `{"clientId": "app_sf3kdjf3"}`
	FreeformAttributes map[string]string `mandatory:"false" json:"freeformAttributes"`

	// The identity provider service or product.
	// Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft
	// Active Directory Federation Services (ADFS).
	// Example: `IDCS`
	ProductType CreateIdentityProviderDetailsProductTypeEnum `mandatory:"true" json:"productType"`
}

CreateSaml2IdentityProviderDetails The representation of CreateSaml2IdentityProviderDetails

func (CreateSaml2IdentityProviderDetails) GetCompartmentId ¶

func (m CreateSaml2IdentityProviderDetails) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CreateSaml2IdentityProviderDetails) GetDefinedTags ¶

func (m CreateSaml2IdentityProviderDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateSaml2IdentityProviderDetails) GetDescription ¶

func (m CreateSaml2IdentityProviderDetails) GetDescription() *string

GetDescription returns Description

func (CreateSaml2IdentityProviderDetails) GetFreeformTags ¶

func (m CreateSaml2IdentityProviderDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateSaml2IdentityProviderDetails) GetName ¶

GetName returns Name

func (CreateSaml2IdentityProviderDetails) GetProductType ¶

GetProductType returns ProductType

func (CreateSaml2IdentityProviderDetails) MarshalJSON ¶

func (m CreateSaml2IdentityProviderDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateSaml2IdentityProviderDetails) String ¶

func (CreateSaml2IdentityProviderDetails) ValidateEnumValue ¶

func (m CreateSaml2IdentityProviderDetails) 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

type CreateSmtpCredentialDetails ¶

type CreateSmtpCredentialDetails struct {

	// The description you assign to the SMTP credentials during creation. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`
}

CreateSmtpCredentialDetails The representation of CreateSmtpCredentialDetails

func (CreateSmtpCredentialDetails) String ¶

func (CreateSmtpCredentialDetails) ValidateEnumValue ¶

func (m CreateSmtpCredentialDetails) 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

type CreateSmtpCredentialRequest ¶

type CreateSmtpCredentialRequest struct {

	// Request object for creating a new SMTP credential with the user.
	CreateSmtpCredentialDetails `contributesTo:"body"`

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateSmtpCredentialRequest wrapper for the CreateSmtpCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateSmtpCredential.go.html to see an example of how to use CreateSmtpCredentialRequest.

func (CreateSmtpCredentialRequest) BinaryRequestBody ¶

func (request CreateSmtpCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSmtpCredentialRequest) HTTPRequest ¶

func (request CreateSmtpCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSmtpCredentialRequest) RetryPolicy ¶

func (request CreateSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSmtpCredentialRequest) String ¶

func (request CreateSmtpCredentialRequest) String() string

func (CreateSmtpCredentialRequest) ValidateEnumValue ¶

func (request CreateSmtpCredentialRequest) 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

type CreateSmtpCredentialResponse ¶

type CreateSmtpCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SmtpCredential instance
	SmtpCredential `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateSmtpCredentialResponse wrapper for the CreateSmtpCredential operation

func (CreateSmtpCredentialResponse) HTTPResponse ¶

func (response CreateSmtpCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSmtpCredentialResponse) String ¶

func (response CreateSmtpCredentialResponse) String() string

type CreateSwiftPasswordDetails ¶

type CreateSwiftPasswordDetails struct {

	// The description you assign to the Swift password during creation. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`
}

CreateSwiftPasswordDetails The representation of CreateSwiftPasswordDetails

func (CreateSwiftPasswordDetails) String ¶

func (CreateSwiftPasswordDetails) ValidateEnumValue ¶

func (m CreateSwiftPasswordDetails) 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

type CreateSwiftPasswordRequest ¶

type CreateSwiftPasswordRequest struct {

	// Request object for creating a new swift password.
	CreateSwiftPasswordDetails `contributesTo:"body"`

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateSwiftPasswordRequest wrapper for the CreateSwiftPassword operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateSwiftPassword.go.html to see an example of how to use CreateSwiftPasswordRequest.

func (CreateSwiftPasswordRequest) BinaryRequestBody ¶

func (request CreateSwiftPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSwiftPasswordRequest) HTTPRequest ¶

func (request CreateSwiftPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSwiftPasswordRequest) RetryPolicy ¶

func (request CreateSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSwiftPasswordRequest) String ¶

func (request CreateSwiftPasswordRequest) String() string

func (CreateSwiftPasswordRequest) ValidateEnumValue ¶

func (request CreateSwiftPasswordRequest) 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

type CreateSwiftPasswordResponse ¶

type CreateSwiftPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SwiftPassword instance
	SwiftPassword `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateSwiftPasswordResponse wrapper for the CreateSwiftPassword operation

func (CreateSwiftPasswordResponse) HTTPResponse ¶

func (response CreateSwiftPasswordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSwiftPasswordResponse) String ¶

func (response CreateSwiftPasswordResponse) String() string

type CreateTagDefaultDetails ¶

type CreateTagDefaultDetails struct {

	// The OCID of the compartment. The tag default will be applied to all new resources created in this compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
	TagDefinitionId *string `mandatory:"true" json:"tagDefinitionId"`

	// The default value for the tag definition. This will be applied to all new resources created in the compartment.
	Value *string `mandatory:"true" json:"value"`

	// If you specify that a value is required, a value is set during resource creation (either by
	// the user creating the resource or another tag defualt). If no value is set, resource
	// creation is blocked.
	// * If the `isRequired` flag is set to "true", the value is set during resource creation.
	// * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.
	// Example: `false`
	IsRequired *bool `mandatory:"false" json:"isRequired"`

	// Locks associated with this resource.
	Locks []AddLockDetails `mandatory:"false" json:"locks"`
}

CreateTagDefaultDetails The representation of CreateTagDefaultDetails

func (CreateTagDefaultDetails) String ¶

func (m CreateTagDefaultDetails) String() string

func (CreateTagDefaultDetails) ValidateEnumValue ¶

func (m CreateTagDefaultDetails) 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

type CreateTagDefaultRequest ¶

type CreateTagDefaultRequest struct {

	// Request object for creating a new tag default.
	CreateTagDefaultDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateTagDefaultRequest wrapper for the CreateTagDefault operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTagDefault.go.html to see an example of how to use CreateTagDefaultRequest.

func (CreateTagDefaultRequest) BinaryRequestBody ¶

func (request CreateTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateTagDefaultRequest) HTTPRequest ¶

func (request CreateTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTagDefaultRequest) RetryPolicy ¶

func (request CreateTagDefaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateTagDefaultRequest) String ¶

func (request CreateTagDefaultRequest) String() string

func (CreateTagDefaultRequest) ValidateEnumValue ¶

func (request CreateTagDefaultRequest) 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

type CreateTagDefaultResponse ¶

type CreateTagDefaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagDefault instance
	TagDefault `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateTagDefaultResponse wrapper for the CreateTagDefault operation

func (CreateTagDefaultResponse) HTTPResponse ¶

func (response CreateTagDefaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateTagDefaultResponse) String ¶

func (response CreateTagDefaultResponse) String() string

type CreateTagDetails ¶

type CreateTagDetails struct {

	// The name you assign to the tag during creation. This is the tag key definition.
	// The name must be unique within the tag namespace and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the tag during creation.
	Description *string `mandatory:"true" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Indicates whether the tag is enabled for cost tracking.
	IsCostTracking *bool `mandatory:"false" json:"isCostTracking"`

	Validator BaseTagDefinitionValidator `mandatory:"false" json:"validator"`
}

CreateTagDetails The representation of CreateTagDetails

func (CreateTagDetails) String ¶

func (m CreateTagDetails) String() string

func (*CreateTagDetails) UnmarshalJSON ¶

func (m *CreateTagDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateTagDetails) ValidateEnumValue ¶

func (m CreateTagDetails) 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

type CreateTagNamespaceDetails ¶

type CreateTagNamespaceDetails struct {

	// The OCID of the tenancy containing the tag namespace.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the tag namespace during creation. It must be unique across all tag namespaces in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the tag namespace during creation.
	Description *string `mandatory:"true" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Locks associated with this resource.
	Locks []AddLockDetails `mandatory:"false" json:"locks"`
}

CreateTagNamespaceDetails The representation of CreateTagNamespaceDetails

func (CreateTagNamespaceDetails) String ¶

func (m CreateTagNamespaceDetails) String() string

func (CreateTagNamespaceDetails) ValidateEnumValue ¶

func (m CreateTagNamespaceDetails) 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

type CreateTagNamespaceRequest ¶

type CreateTagNamespaceRequest struct {

	// Request object for creating a new tag namespace.
	CreateTagNamespaceDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateTagNamespaceRequest wrapper for the CreateTagNamespace operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTagNamespace.go.html to see an example of how to use CreateTagNamespaceRequest.

func (CreateTagNamespaceRequest) BinaryRequestBody ¶

func (request CreateTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateTagNamespaceRequest) HTTPRequest ¶

func (request CreateTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTagNamespaceRequest) RetryPolicy ¶

func (request CreateTagNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateTagNamespaceRequest) String ¶

func (request CreateTagNamespaceRequest) String() string

func (CreateTagNamespaceRequest) ValidateEnumValue ¶

func (request CreateTagNamespaceRequest) 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

type CreateTagNamespaceResponse ¶

type CreateTagNamespaceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagNamespace instance
	TagNamespace `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"`
}

CreateTagNamespaceResponse wrapper for the CreateTagNamespace operation

func (CreateTagNamespaceResponse) HTTPResponse ¶

func (response CreateTagNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateTagNamespaceResponse) String ¶

func (response CreateTagNamespaceResponse) String() string

type CreateTagRequest ¶

type CreateTagRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// Request object for creating a new tag in the specified tag namespace.
	CreateTagDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

CreateTagRequest wrapper for the CreateTag operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTag.go.html to see an example of how to use CreateTagRequest.

func (CreateTagRequest) BinaryRequestBody ¶

func (request CreateTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateTagRequest) HTTPRequest ¶

func (request CreateTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTagRequest) RetryPolicy ¶

func (request CreateTagRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateTagRequest) String ¶

func (request CreateTagRequest) String() string

func (CreateTagRequest) ValidateEnumValue ¶

func (request CreateTagRequest) 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

type CreateTagResponse ¶

type CreateTagResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Tag instance
	Tag `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateTagResponse wrapper for the CreateTag operation

func (CreateTagResponse) HTTPResponse ¶

func (response CreateTagResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateTagResponse) String ¶

func (response CreateTagResponse) String() string

type CreateUserDetails ¶

type CreateUserDetails struct {

	// The OCID of the tenancy containing the user.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the user during creation. This is the user's login for the Console.
	// The name must be unique across all users in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the user during creation. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// The email you assign to the user during creation. The email must be unique across all users in the tenancy.
	// (For tenancies that support identity domains) You must provide an email for each user.
	Email *string `mandatory:"false" json:"email"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateUserDetails The representation of CreateUserDetails

func (CreateUserDetails) String ¶

func (m CreateUserDetails) String() string

func (CreateUserDetails) ValidateEnumValue ¶

func (m CreateUserDetails) 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

type CreateUserRequest ¶

type CreateUserRequest struct {

	// Request object for creating a new user.
	CreateUserDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateUserRequest wrapper for the CreateUser operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateUser.go.html to see an example of how to use CreateUserRequest.

func (CreateUserRequest) BinaryRequestBody ¶

func (request CreateUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateUserRequest) HTTPRequest ¶

func (request CreateUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateUserRequest) RetryPolicy ¶

func (request CreateUserRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateUserRequest) String ¶

func (request CreateUserRequest) String() string

func (CreateUserRequest) ValidateEnumValue ¶

func (request CreateUserRequest) 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

type CreateUserResponse ¶

type CreateUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateUserResponse wrapper for the CreateUser operation

func (CreateUserResponse) HTTPResponse ¶

func (response CreateUserResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateUserResponse) String ¶

func (response CreateUserResponse) String() string

type CustomerSecretKey ¶

type CustomerSecretKey struct {

	// The secret key.
	Key *string `mandatory:"false" json:"key"`

	// The access key portion of the key pair.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the password belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The display name you assign to the secret key. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this password will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState CustomerSecretKeyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

CustomerSecretKey A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's Amazon S3 compatible API (https://docs.cloud.oracle.com/Content/Object/Tasks/s3compatibleapi.htm). The key consists of a secret key/access key pair. A user can have up to two secret keys at a time. **Note:** The secret key is always an Oracle-generated string; you can't change it to a string of your choice. For more information, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).

func (CustomerSecretKey) String ¶

func (m CustomerSecretKey) String() string

func (CustomerSecretKey) ValidateEnumValue ¶

func (m CustomerSecretKey) 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

type CustomerSecretKeyLifecycleStateEnum ¶

type CustomerSecretKeyLifecycleStateEnum string

CustomerSecretKeyLifecycleStateEnum Enum with underlying type: string

const (
	CustomerSecretKeyLifecycleStateCreating CustomerSecretKeyLifecycleStateEnum = "CREATING"
	CustomerSecretKeyLifecycleStateActive   CustomerSecretKeyLifecycleStateEnum = "ACTIVE"
	CustomerSecretKeyLifecycleStateInactive CustomerSecretKeyLifecycleStateEnum = "INACTIVE"
	CustomerSecretKeyLifecycleStateDeleting CustomerSecretKeyLifecycleStateEnum = "DELETING"
	CustomerSecretKeyLifecycleStateDeleted  CustomerSecretKeyLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for CustomerSecretKeyLifecycleStateEnum

func GetCustomerSecretKeyLifecycleStateEnumValues ¶

func GetCustomerSecretKeyLifecycleStateEnumValues() []CustomerSecretKeyLifecycleStateEnum

GetCustomerSecretKeyLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeyLifecycleStateEnum

func GetMappingCustomerSecretKeyLifecycleStateEnum ¶

func GetMappingCustomerSecretKeyLifecycleStateEnum(val string) (CustomerSecretKeyLifecycleStateEnum, bool)

GetMappingCustomerSecretKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type CustomerSecretKeySummary ¶

type CustomerSecretKeySummary struct {

	// The OCID of the secret key.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the password belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The displayName you assign to the secret key. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Date and time the `CustomerSecretKey` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this password will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The secret key's current state. After creating a secret key, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState CustomerSecretKeySummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

CustomerSecretKeySummary As the name suggests, a `CustomerSecretKeySummary` object contains information about a `CustomerSecretKey`. A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's Amazon S3 compatible API.

func (CustomerSecretKeySummary) String ¶

func (m CustomerSecretKeySummary) String() string

func (CustomerSecretKeySummary) ValidateEnumValue ¶

func (m CustomerSecretKeySummary) 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

type CustomerSecretKeySummaryLifecycleStateEnum ¶

type CustomerSecretKeySummaryLifecycleStateEnum string

CustomerSecretKeySummaryLifecycleStateEnum Enum with underlying type: string

const (
	CustomerSecretKeySummaryLifecycleStateCreating CustomerSecretKeySummaryLifecycleStateEnum = "CREATING"
	CustomerSecretKeySummaryLifecycleStateActive   CustomerSecretKeySummaryLifecycleStateEnum = "ACTIVE"
	CustomerSecretKeySummaryLifecycleStateInactive CustomerSecretKeySummaryLifecycleStateEnum = "INACTIVE"
	CustomerSecretKeySummaryLifecycleStateDeleting CustomerSecretKeySummaryLifecycleStateEnum = "DELETING"
	CustomerSecretKeySummaryLifecycleStateDeleted  CustomerSecretKeySummaryLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for CustomerSecretKeySummaryLifecycleStateEnum

func GetCustomerSecretKeySummaryLifecycleStateEnumValues ¶

func GetCustomerSecretKeySummaryLifecycleStateEnumValues() []CustomerSecretKeySummaryLifecycleStateEnum

GetCustomerSecretKeySummaryLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeySummaryLifecycleStateEnum

func GetMappingCustomerSecretKeySummaryLifecycleStateEnum ¶

func GetMappingCustomerSecretKeySummaryLifecycleStateEnum(val string) (CustomerSecretKeySummaryLifecycleStateEnum, bool)

GetMappingCustomerSecretKeySummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DbCredential ¶

type DbCredential struct {

	// The OCID of the DB credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the DB credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time the `DbCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The credential's current state. After creating a DB credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState DbCredentialLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	LifecycleDetails *int64 `mandatory:"false" json:"lifecycleDetails"`
}

DbCredential Database credentials are needed for onboarding cloud database to identity. The DB credentials are used for DB authentication with the service.

func (DbCredential) String ¶

func (m DbCredential) String() string

func (DbCredential) ValidateEnumValue ¶

func (m DbCredential) 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

type DbCredentialLifecycleStateEnum ¶

type DbCredentialLifecycleStateEnum string

DbCredentialLifecycleStateEnum Enum with underlying type: string

const (
	DbCredentialLifecycleStateCreating DbCredentialLifecycleStateEnum = "CREATING"
	DbCredentialLifecycleStateActive   DbCredentialLifecycleStateEnum = "ACTIVE"
	DbCredentialLifecycleStateDeleting DbCredentialLifecycleStateEnum = "DELETING"
	DbCredentialLifecycleStateDeleted  DbCredentialLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for DbCredentialLifecycleStateEnum

func GetDbCredentialLifecycleStateEnumValues ¶

func GetDbCredentialLifecycleStateEnumValues() []DbCredentialLifecycleStateEnum

GetDbCredentialLifecycleStateEnumValues Enumerates the set of values for DbCredentialLifecycleStateEnum

func GetMappingDbCredentialLifecycleStateEnum ¶

func GetMappingDbCredentialLifecycleStateEnum(val string) (DbCredentialLifecycleStateEnum, bool)

GetMappingDbCredentialLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DbCredentialSummary ¶

type DbCredentialSummary struct {

	// The OCID of the DB credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the DB credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The description you assign to the DB credential. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// Date and time the `DbCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The credential's current state. After creating a DB credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState DbCredentialLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

DbCredentialSummary As the name suggests, an `DbCredentialSummary` object contains information about an `DbCredential`. The DB credential is used for DB authentication with the [DB Service].

func (DbCredentialSummary) String ¶

func (m DbCredentialSummary) String() string

func (DbCredentialSummary) ValidateEnumValue ¶

func (m DbCredentialSummary) 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

type DeactivateDomainRequest ¶

type DeactivateDomainRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeactivateDomainRequest wrapper for the DeactivateDomain operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeactivateDomain.go.html to see an example of how to use DeactivateDomainRequest.

func (DeactivateDomainRequest) BinaryRequestBody ¶

func (request DeactivateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeactivateDomainRequest) HTTPRequest ¶

func (request DeactivateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeactivateDomainRequest) RetryPolicy ¶

func (request DeactivateDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeactivateDomainRequest) String ¶

func (request DeactivateDomainRequest) String() string

func (DeactivateDomainRequest) ValidateEnumValue ¶

func (request DeactivateDomainRequest) 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

type DeactivateDomainResponse ¶

type DeactivateDomainResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeactivateDomainResponse wrapper for the DeactivateDomain operation

func (DeactivateDomainResponse) HTTPResponse ¶

func (response DeactivateDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeactivateDomainResponse) String ¶

func (response DeactivateDomainResponse) String() string

type DefaultTagDefinitionValidator ¶

type DefaultTagDefinitionValidator struct {
}

DefaultTagDefinitionValidator Use this validator to clear any existing validator on the tag key definition with the UpdateTag operation. Using this `validatorType` is the same as not setting any value on the validator field. The resultant value for `validatorType` returned in the response body is `null`.

func (DefaultTagDefinitionValidator) MarshalJSON ¶

func (m DefaultTagDefinitionValidator) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DefaultTagDefinitionValidator) String ¶

func (DefaultTagDefinitionValidator) ValidateEnumValue ¶

func (m DefaultTagDefinitionValidator) 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

type DeleteApiKeyRequest ¶

type DeleteApiKeyRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The key's fingerprint.
	Fingerprint *string `mandatory:"true" contributesTo:"path" name:"fingerprint"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteApiKeyRequest wrapper for the DeleteApiKey operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteApiKey.go.html to see an example of how to use DeleteApiKeyRequest.

func (DeleteApiKeyRequest) BinaryRequestBody ¶

func (request DeleteApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteApiKeyRequest) HTTPRequest ¶

func (request DeleteApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteApiKeyRequest) RetryPolicy ¶

func (request DeleteApiKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteApiKeyRequest) String ¶

func (request DeleteApiKeyRequest) String() string

func (DeleteApiKeyRequest) ValidateEnumValue ¶

func (request DeleteApiKeyRequest) 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

type DeleteApiKeyResponse ¶

type DeleteApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteApiKeyResponse wrapper for the DeleteApiKey operation

func (DeleteApiKeyResponse) HTTPResponse ¶

func (response DeleteApiKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteApiKeyResponse) String ¶

func (response DeleteApiKeyResponse) String() string

type DeleteAuthTokenRequest ¶

type DeleteAuthTokenRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the auth token.
	AuthTokenId *string `mandatory:"true" contributesTo:"path" name:"authTokenId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteAuthTokenRequest wrapper for the DeleteAuthToken operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteAuthToken.go.html to see an example of how to use DeleteAuthTokenRequest.

func (DeleteAuthTokenRequest) BinaryRequestBody ¶

func (request DeleteAuthTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAuthTokenRequest) HTTPRequest ¶

func (request DeleteAuthTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAuthTokenRequest) RetryPolicy ¶

func (request DeleteAuthTokenRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAuthTokenRequest) String ¶

func (request DeleteAuthTokenRequest) String() string

func (DeleteAuthTokenRequest) ValidateEnumValue ¶

func (request DeleteAuthTokenRequest) 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

type DeleteAuthTokenResponse ¶

type DeleteAuthTokenResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteAuthTokenResponse wrapper for the DeleteAuthToken operation

func (DeleteAuthTokenResponse) HTTPResponse ¶

func (response DeleteAuthTokenResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAuthTokenResponse) String ¶

func (response DeleteAuthTokenResponse) String() string

type DeleteCompartmentRequest ¶

type DeleteCompartmentRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteCompartmentRequest wrapper for the DeleteCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteCompartment.go.html to see an example of how to use DeleteCompartmentRequest.

func (DeleteCompartmentRequest) BinaryRequestBody ¶

func (request DeleteCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteCompartmentRequest) HTTPRequest ¶

func (request DeleteCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCompartmentRequest) RetryPolicy ¶

func (request DeleteCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteCompartmentRequest) String ¶

func (request DeleteCompartmentRequest) String() string

func (DeleteCompartmentRequest) ValidateEnumValue ¶

func (request DeleteCompartmentRequest) 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

type DeleteCompartmentResponse ¶

type DeleteCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeleteCompartmentResponse wrapper for the DeleteCompartment operation

func (DeleteCompartmentResponse) HTTPResponse ¶

func (response DeleteCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteCompartmentResponse) String ¶

func (response DeleteCompartmentResponse) String() string

type DeleteCustomerSecretKeyRequest ¶

type DeleteCustomerSecretKeyRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The access token of the secret key.
	CustomerSecretKeyId *string `mandatory:"true" contributesTo:"path" name:"customerSecretKeyId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteCustomerSecretKeyRequest wrapper for the DeleteCustomerSecretKey operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteCustomerSecretKey.go.html to see an example of how to use DeleteCustomerSecretKeyRequest.

func (DeleteCustomerSecretKeyRequest) BinaryRequestBody ¶

func (request DeleteCustomerSecretKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteCustomerSecretKeyRequest) HTTPRequest ¶

func (request DeleteCustomerSecretKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCustomerSecretKeyRequest) RetryPolicy ¶

func (request DeleteCustomerSecretKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteCustomerSecretKeyRequest) String ¶

func (request DeleteCustomerSecretKeyRequest) String() string

func (DeleteCustomerSecretKeyRequest) ValidateEnumValue ¶

func (request DeleteCustomerSecretKeyRequest) 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

type DeleteCustomerSecretKeyResponse ¶

type DeleteCustomerSecretKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteCustomerSecretKeyResponse wrapper for the DeleteCustomerSecretKey operation

func (DeleteCustomerSecretKeyResponse) HTTPResponse ¶

func (response DeleteCustomerSecretKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteCustomerSecretKeyResponse) String ¶

func (response DeleteCustomerSecretKeyResponse) String() string

type DeleteDbCredentialRequest ¶

type DeleteDbCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the DB credential.
	DbCredentialId *string `mandatory:"true" contributesTo:"path" name:"dbCredentialId"`

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

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteDbCredentialRequest wrapper for the DeleteDbCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDbCredential.go.html to see an example of how to use DeleteDbCredentialRequest.

func (DeleteDbCredentialRequest) BinaryRequestBody ¶

func (request DeleteDbCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDbCredentialRequest) HTTPRequest ¶

func (request DeleteDbCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDbCredentialRequest) RetryPolicy ¶

func (request DeleteDbCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDbCredentialRequest) String ¶

func (request DeleteDbCredentialRequest) String() string

func (DeleteDbCredentialRequest) ValidateEnumValue ¶

func (request DeleteDbCredentialRequest) 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

type DeleteDbCredentialResponse ¶

type DeleteDbCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteDbCredentialResponse wrapper for the DeleteDbCredential operation

func (DeleteDbCredentialResponse) HTTPResponse ¶

func (response DeleteDbCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDbCredentialResponse) String ¶

func (response DeleteDbCredentialResponse) String() string

type DeleteDomainRequest ¶

type DeleteDomainRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteDomainRequest wrapper for the DeleteDomain operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDomain.go.html to see an example of how to use DeleteDomainRequest.

func (DeleteDomainRequest) BinaryRequestBody ¶

func (request DeleteDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDomainRequest) HTTPRequest ¶

func (request DeleteDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDomainRequest) RetryPolicy ¶

func (request DeleteDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDomainRequest) String ¶

func (request DeleteDomainRequest) String() string

func (DeleteDomainRequest) ValidateEnumValue ¶

func (request DeleteDomainRequest) 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

type DeleteDomainResponse ¶

type DeleteDomainResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeleteDomainResponse wrapper for the DeleteDomain operation

func (DeleteDomainResponse) HTTPResponse ¶

func (response DeleteDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDomainResponse) String ¶

func (response DeleteDomainResponse) String() string

type DeleteDynamicGroupRequest ¶

type DeleteDynamicGroupRequest struct {

	// The OCID of the dynamic group.
	DynamicGroupId *string `mandatory:"true" contributesTo:"path" name:"dynamicGroupId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteDynamicGroupRequest wrapper for the DeleteDynamicGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDynamicGroup.go.html to see an example of how to use DeleteDynamicGroupRequest.

func (DeleteDynamicGroupRequest) BinaryRequestBody ¶

func (request DeleteDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDynamicGroupRequest) HTTPRequest ¶

func (request DeleteDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDynamicGroupRequest) RetryPolicy ¶

func (request DeleteDynamicGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDynamicGroupRequest) String ¶

func (request DeleteDynamicGroupRequest) String() string

func (DeleteDynamicGroupRequest) ValidateEnumValue ¶

func (request DeleteDynamicGroupRequest) 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

type DeleteDynamicGroupResponse ¶

type DeleteDynamicGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteDynamicGroupResponse wrapper for the DeleteDynamicGroup operation

func (DeleteDynamicGroupResponse) HTTPResponse ¶

func (response DeleteDynamicGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDynamicGroupResponse) String ¶

func (response DeleteDynamicGroupResponse) String() string

type DeleteGroupRequest ¶

type DeleteGroupRequest struct {

	// The OCID of the group.
	GroupId *string `mandatory:"true" contributesTo:"path" name:"groupId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteGroupRequest wrapper for the DeleteGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteGroup.go.html to see an example of how to use DeleteGroupRequest.

func (DeleteGroupRequest) BinaryRequestBody ¶

func (request DeleteGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteGroupRequest) HTTPRequest ¶

func (request DeleteGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteGroupRequest) RetryPolicy ¶

func (request DeleteGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteGroupRequest) String ¶

func (request DeleteGroupRequest) String() string

func (DeleteGroupRequest) ValidateEnumValue ¶

func (request DeleteGroupRequest) 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

type DeleteGroupResponse ¶

type DeleteGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteGroupResponse wrapper for the DeleteGroup operation

func (DeleteGroupResponse) HTTPResponse ¶

func (response DeleteGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteGroupResponse) String ¶

func (response DeleteGroupResponse) String() string

type DeleteIdentityProviderRequest ¶

type DeleteIdentityProviderRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteIdentityProviderRequest wrapper for the DeleteIdentityProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteIdentityProvider.go.html to see an example of how to use DeleteIdentityProviderRequest.

func (DeleteIdentityProviderRequest) BinaryRequestBody ¶

func (request DeleteIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteIdentityProviderRequest) HTTPRequest ¶

func (request DeleteIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIdentityProviderRequest) RetryPolicy ¶

func (request DeleteIdentityProviderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteIdentityProviderRequest) String ¶

func (request DeleteIdentityProviderRequest) String() string

func (DeleteIdentityProviderRequest) ValidateEnumValue ¶

func (request DeleteIdentityProviderRequest) 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

type DeleteIdentityProviderResponse ¶

type DeleteIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteIdentityProviderResponse wrapper for the DeleteIdentityProvider operation

func (DeleteIdentityProviderResponse) HTTPResponse ¶

func (response DeleteIdentityProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteIdentityProviderResponse) String ¶

func (response DeleteIdentityProviderResponse) String() string

type DeleteIdpGroupMappingRequest ¶

type DeleteIdpGroupMappingRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// The OCID of the group mapping.
	MappingId *string `mandatory:"true" contributesTo:"path" name:"mappingId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteIdpGroupMappingRequest wrapper for the DeleteIdpGroupMapping operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteIdpGroupMapping.go.html to see an example of how to use DeleteIdpGroupMappingRequest.

func (DeleteIdpGroupMappingRequest) BinaryRequestBody ¶

func (request DeleteIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteIdpGroupMappingRequest) HTTPRequest ¶

func (request DeleteIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIdpGroupMappingRequest) RetryPolicy ¶

func (request DeleteIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteIdpGroupMappingRequest) String ¶

func (request DeleteIdpGroupMappingRequest) String() string

func (DeleteIdpGroupMappingRequest) ValidateEnumValue ¶

func (request DeleteIdpGroupMappingRequest) 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

type DeleteIdpGroupMappingResponse ¶

type DeleteIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteIdpGroupMappingResponse wrapper for the DeleteIdpGroupMapping operation

func (DeleteIdpGroupMappingResponse) HTTPResponse ¶

func (response DeleteIdpGroupMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteIdpGroupMappingResponse) String ¶

func (response DeleteIdpGroupMappingResponse) String() string

type DeleteMfaTotpDeviceRequest ¶

type DeleteMfaTotpDeviceRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the MFA TOTP device.
	MfaTotpDeviceId *string `mandatory:"true" contributesTo:"path" name:"mfaTotpDeviceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteMfaTotpDeviceRequest wrapper for the DeleteMfaTotpDevice operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteMfaTotpDevice.go.html to see an example of how to use DeleteMfaTotpDeviceRequest.

func (DeleteMfaTotpDeviceRequest) BinaryRequestBody ¶

func (request DeleteMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteMfaTotpDeviceRequest) HTTPRequest ¶

func (request DeleteMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteMfaTotpDeviceRequest) RetryPolicy ¶

func (request DeleteMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteMfaTotpDeviceRequest) String ¶

func (request DeleteMfaTotpDeviceRequest) String() string

func (DeleteMfaTotpDeviceRequest) ValidateEnumValue ¶

func (request DeleteMfaTotpDeviceRequest) 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

type DeleteMfaTotpDeviceResponse ¶

type DeleteMfaTotpDeviceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteMfaTotpDeviceResponse wrapper for the DeleteMfaTotpDevice operation

func (DeleteMfaTotpDeviceResponse) HTTPResponse ¶

func (response DeleteMfaTotpDeviceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteMfaTotpDeviceResponse) String ¶

func (response DeleteMfaTotpDeviceResponse) String() string

type DeleteNetworkSourceRequest ¶

type DeleteNetworkSourceRequest struct {

	// The OCID of the network source.
	NetworkSourceId *string `mandatory:"true" contributesTo:"path" name:"networkSourceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteNetworkSourceRequest wrapper for the DeleteNetworkSource operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteNetworkSource.go.html to see an example of how to use DeleteNetworkSourceRequest.

func (DeleteNetworkSourceRequest) BinaryRequestBody ¶

func (request DeleteNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteNetworkSourceRequest) HTTPRequest ¶

func (request DeleteNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteNetworkSourceRequest) RetryPolicy ¶

func (request DeleteNetworkSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteNetworkSourceRequest) String ¶

func (request DeleteNetworkSourceRequest) String() string

func (DeleteNetworkSourceRequest) ValidateEnumValue ¶

func (request DeleteNetworkSourceRequest) 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

type DeleteNetworkSourceResponse ¶

type DeleteNetworkSourceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteNetworkSourceResponse wrapper for the DeleteNetworkSource operation

func (DeleteNetworkSourceResponse) HTTPResponse ¶

func (response DeleteNetworkSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteNetworkSourceResponse) String ¶

func (response DeleteNetworkSourceResponse) String() string

type DeleteOAuthClientCredentialRequest ¶

type DeleteOAuthClientCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The ID of the Oauth credential.
	Oauth2ClientCredentialId *string `mandatory:"true" contributesTo:"path" name:"oauth2ClientCredentialId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteOAuthClientCredentialRequest wrapper for the DeleteOAuthClientCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteOAuthClientCredential.go.html to see an example of how to use DeleteOAuthClientCredentialRequest.

func (DeleteOAuthClientCredentialRequest) BinaryRequestBody ¶

func (request DeleteOAuthClientCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteOAuthClientCredentialRequest) HTTPRequest ¶

func (request DeleteOAuthClientCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOAuthClientCredentialRequest) RetryPolicy ¶

func (request DeleteOAuthClientCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOAuthClientCredentialRequest) String ¶

func (request DeleteOAuthClientCredentialRequest) String() string

func (DeleteOAuthClientCredentialRequest) ValidateEnumValue ¶

func (request DeleteOAuthClientCredentialRequest) 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

type DeleteOAuthClientCredentialResponse ¶

type DeleteOAuthClientCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteOAuthClientCredentialResponse wrapper for the DeleteOAuthClientCredential operation

func (DeleteOAuthClientCredentialResponse) HTTPResponse ¶

func (response DeleteOAuthClientCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOAuthClientCredentialResponse) String ¶

func (response DeleteOAuthClientCredentialResponse) String() string

type DeletePolicyRequest ¶

type DeletePolicyRequest struct {

	// The OCID of the policy.
	PolicyId *string `mandatory:"true" contributesTo:"path" name:"policyId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeletePolicyRequest wrapper for the DeletePolicy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeletePolicy.go.html to see an example of how to use DeletePolicyRequest.

func (DeletePolicyRequest) BinaryRequestBody ¶

func (request DeletePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeletePolicyRequest) HTTPRequest ¶

func (request DeletePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePolicyRequest) RetryPolicy ¶

func (request DeletePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeletePolicyRequest) String ¶

func (request DeletePolicyRequest) String() string

func (DeletePolicyRequest) ValidateEnumValue ¶

func (request DeletePolicyRequest) 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

type DeletePolicyResponse ¶

type DeletePolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeletePolicyResponse wrapper for the DeletePolicy operation

func (DeletePolicyResponse) HTTPResponse ¶

func (response DeletePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeletePolicyResponse) String ¶

func (response DeletePolicyResponse) String() string

type DeleteSmtpCredentialRequest ¶

type DeleteSmtpCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the SMTP credential.
	SmtpCredentialId *string `mandatory:"true" contributesTo:"path" name:"smtpCredentialId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteSmtpCredentialRequest wrapper for the DeleteSmtpCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteSmtpCredential.go.html to see an example of how to use DeleteSmtpCredentialRequest.

func (DeleteSmtpCredentialRequest) BinaryRequestBody ¶

func (request DeleteSmtpCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSmtpCredentialRequest) HTTPRequest ¶

func (request DeleteSmtpCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSmtpCredentialRequest) RetryPolicy ¶

func (request DeleteSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSmtpCredentialRequest) String ¶

func (request DeleteSmtpCredentialRequest) String() string

func (DeleteSmtpCredentialRequest) ValidateEnumValue ¶

func (request DeleteSmtpCredentialRequest) 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

type DeleteSmtpCredentialResponse ¶

type DeleteSmtpCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteSmtpCredentialResponse wrapper for the DeleteSmtpCredential operation

func (DeleteSmtpCredentialResponse) HTTPResponse ¶

func (response DeleteSmtpCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSmtpCredentialResponse) String ¶

func (response DeleteSmtpCredentialResponse) String() string

type DeleteSwiftPasswordRequest ¶

type DeleteSwiftPasswordRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the Swift password.
	SwiftPasswordId *string `mandatory:"true" contributesTo:"path" name:"swiftPasswordId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteSwiftPasswordRequest wrapper for the DeleteSwiftPassword operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteSwiftPassword.go.html to see an example of how to use DeleteSwiftPasswordRequest.

func (DeleteSwiftPasswordRequest) BinaryRequestBody ¶

func (request DeleteSwiftPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSwiftPasswordRequest) HTTPRequest ¶

func (request DeleteSwiftPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSwiftPasswordRequest) RetryPolicy ¶

func (request DeleteSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSwiftPasswordRequest) String ¶

func (request DeleteSwiftPasswordRequest) String() string

func (DeleteSwiftPasswordRequest) ValidateEnumValue ¶

func (request DeleteSwiftPasswordRequest) 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

type DeleteSwiftPasswordResponse ¶

type DeleteSwiftPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteSwiftPasswordResponse wrapper for the DeleteSwiftPassword operation

func (DeleteSwiftPasswordResponse) HTTPResponse ¶

func (response DeleteSwiftPasswordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSwiftPasswordResponse) String ¶

func (response DeleteSwiftPasswordResponse) String() string

type DeleteTagDefaultRequest ¶

type DeleteTagDefaultRequest struct {

	// The OCID of the tag default.
	TagDefaultId *string `mandatory:"true" contributesTo:"path" name:"tagDefaultId"`

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

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

DeleteTagDefaultRequest wrapper for the DeleteTagDefault operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTagDefault.go.html to see an example of how to use DeleteTagDefaultRequest.

func (DeleteTagDefaultRequest) BinaryRequestBody ¶

func (request DeleteTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteTagDefaultRequest) HTTPRequest ¶

func (request DeleteTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTagDefaultRequest) RetryPolicy ¶

func (request DeleteTagDefaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteTagDefaultRequest) String ¶

func (request DeleteTagDefaultRequest) String() string

func (DeleteTagDefaultRequest) ValidateEnumValue ¶

func (request DeleteTagDefaultRequest) 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

type DeleteTagDefaultResponse ¶

type DeleteTagDefaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteTagDefaultResponse wrapper for the DeleteTagDefault operation

func (DeleteTagDefaultResponse) HTTPResponse ¶

func (response DeleteTagDefaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteTagDefaultResponse) String ¶

func (response DeleteTagDefaultResponse) String() string

type DeleteTagNamespaceRequest ¶

type DeleteTagNamespaceRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

DeleteTagNamespaceRequest wrapper for the DeleteTagNamespace operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTagNamespace.go.html to see an example of how to use DeleteTagNamespaceRequest.

func (DeleteTagNamespaceRequest) BinaryRequestBody ¶

func (request DeleteTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteTagNamespaceRequest) HTTPRequest ¶

func (request DeleteTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTagNamespaceRequest) RetryPolicy ¶

func (request DeleteTagNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteTagNamespaceRequest) String ¶

func (request DeleteTagNamespaceRequest) String() string

func (DeleteTagNamespaceRequest) ValidateEnumValue ¶

func (request DeleteTagNamespaceRequest) 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

type DeleteTagNamespaceResponse ¶

type DeleteTagNamespaceResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteTagNamespaceResponse wrapper for the DeleteTagNamespace operation

func (DeleteTagNamespaceResponse) HTTPResponse ¶

func (response DeleteTagNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteTagNamespaceResponse) String ¶

func (response DeleteTagNamespaceResponse) String() string

type DeleteTagRequest ¶

type DeleteTagRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// The name of the tag.
	TagName *string `mandatory:"true" contributesTo:"path" name:"tagName"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

DeleteTagRequest wrapper for the DeleteTag operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTag.go.html to see an example of how to use DeleteTagRequest.

func (DeleteTagRequest) BinaryRequestBody ¶

func (request DeleteTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteTagRequest) HTTPRequest ¶

func (request DeleteTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTagRequest) RetryPolicy ¶

func (request DeleteTagRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteTagRequest) String ¶

func (request DeleteTagRequest) String() string

func (DeleteTagRequest) ValidateEnumValue ¶

func (request DeleteTagRequest) 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

type DeleteTagResponse ¶

type DeleteTagResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

DeleteTagResponse wrapper for the DeleteTag operation

func (DeleteTagResponse) HTTPResponse ¶

func (response DeleteTagResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteTagResponse) String ¶

func (response DeleteTagResponse) String() string

type DeleteUserRequest ¶

type DeleteUserRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DeleteUserRequest wrapper for the DeleteUser operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteUser.go.html to see an example of how to use DeleteUserRequest.

func (DeleteUserRequest) BinaryRequestBody ¶

func (request DeleteUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteUserRequest) HTTPRequest ¶

func (request DeleteUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteUserRequest) RetryPolicy ¶

func (request DeleteUserRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteUserRequest) String ¶

func (request DeleteUserRequest) String() string

func (DeleteUserRequest) ValidateEnumValue ¶

func (request DeleteUserRequest) 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

type DeleteUserResponse ¶

type DeleteUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteUserResponse wrapper for the DeleteUser operation

func (DeleteUserResponse) HTTPResponse ¶

func (response DeleteUserResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteUserResponse) String ¶

func (response DeleteUserResponse) String() string

type Domain ¶

type Domain struct {

	// The OCID of the identity domain.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment containing the identity domain.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The mutable display name of the identity domain.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The identity domain description. You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// Region-agnostic identity domain URL.
	Url *string `mandatory:"true" json:"url"`

	// Region-specific identity domain URL.
	HomeRegionUrl *string `mandatory:"true" json:"homeRegionUrl"`

	// The home region for the identity domain.
	// See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported region names.
	// Example: `us-phoenix-1`
	HomeRegion *string `mandatory:"true" json:"homeRegion"`

	// The regions where replicas of the identity domain exist.
	ReplicaRegions []ReplicatedRegionDetails `mandatory:"true" json:"replicaRegions"`

	// The type of the domain.
	Type DomainTypeEnum `mandatory:"true" json:"type"`

	// The license type of the identity domain.
	LicenseType *string `mandatory:"true" json:"licenseType"`

	// Indicates whether the identity domain is hidden on the sign-in screen or not.
	IsHiddenOnLogin *bool `mandatory:"true" json:"isHiddenOnLogin"`

	// Date and time the identity domain was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state.
	LifecycleState DomainLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Any additional details about the current state of the identity domain.
	LifecycleDetails DomainLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Domain (For tenancies that support identity domains) Properties for an identity domain. An identity domain is used to manage users and groups, integration standards, external identities, and secure application integration through Oracle Single Sign-on (SSO) configuration.

func (Domain) String ¶

func (m Domain) String() string

func (Domain) ValidateEnumValue ¶

func (m Domain) 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

type DomainLifecycleDetailsEnum ¶

type DomainLifecycleDetailsEnum string

DomainLifecycleDetailsEnum Enum with underlying type: string

const (
	DomainLifecycleDetailsDeactivating DomainLifecycleDetailsEnum = "DEACTIVATING"
	DomainLifecycleDetailsActivating   DomainLifecycleDetailsEnum = "ACTIVATING"
	DomainLifecycleDetailsUpdating     DomainLifecycleDetailsEnum = "UPDATING"
)

Set of constants representing the allowable values for DomainLifecycleDetailsEnum

func GetDomainLifecycleDetailsEnumValues ¶

func GetDomainLifecycleDetailsEnumValues() []DomainLifecycleDetailsEnum

GetDomainLifecycleDetailsEnumValues Enumerates the set of values for DomainLifecycleDetailsEnum

func GetMappingDomainLifecycleDetailsEnum ¶

func GetMappingDomainLifecycleDetailsEnum(val string) (DomainLifecycleDetailsEnum, bool)

GetMappingDomainLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum

type DomainLifecycleStateEnum ¶

type DomainLifecycleStateEnum string

DomainLifecycleStateEnum Enum with underlying type: string

const (
	DomainLifecycleStateCreating DomainLifecycleStateEnum = "CREATING"
	DomainLifecycleStateActive   DomainLifecycleStateEnum = "ACTIVE"
	DomainLifecycleStateDeleting DomainLifecycleStateEnum = "DELETING"
	DomainLifecycleStateInactive DomainLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for DomainLifecycleStateEnum

func GetDomainLifecycleStateEnumValues ¶

func GetDomainLifecycleStateEnumValues() []DomainLifecycleStateEnum

GetDomainLifecycleStateEnumValues Enumerates the set of values for DomainLifecycleStateEnum

func GetMappingDomainLifecycleStateEnum ¶

func GetMappingDomainLifecycleStateEnum(val string) (DomainLifecycleStateEnum, bool)

GetMappingDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DomainReplication ¶

type DomainReplication struct {

	// The version number indicating the value of kievTxnId, starting from which the identity domain replication events need to be returned.
	OpcWaterMark *float32 `mandatory:"true" json:"opcWaterMark"`

	// A custom value defining the order of records with the same kievTxnId.
	TxnSeqNumber *float32 `mandatory:"true" json:"txnSeqNumber"`

	// The identity domain's replication state.
	DomainReplicationStates []DomainReplicationStates `mandatory:"true" json:"domainReplicationStates"`
}

DomainReplication (For tenancies that support identity domains) Identity domain replication states.

func (DomainReplication) String ¶

func (m DomainReplication) String() string

func (DomainReplication) ValidateEnumValue ¶

func (m DomainReplication) 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

type DomainReplicationStates ¶

type DomainReplicationStates struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" json:"domainId"`

	// The IDCS-replicated region state.
	State ReplicatedRegionDetailsStateEnum `mandatory:"true" json:"state"`

	// The replica region for the identity domain.
	ReplicaRegion *string `mandatory:"true" json:"replicaRegion"`
}

DomainReplicationStates (For tenancies that support identity domains) The identity domain replication log for all identity domains for a given region.

func (DomainReplicationStates) String ¶

func (m DomainReplicationStates) String() string

func (DomainReplicationStates) ValidateEnumValue ¶

func (m DomainReplicationStates) 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

type DomainSummary ¶

type DomainSummary struct {

	// The OCID of the identity domain.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment containing the identity domain.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The mutable display name of the identity domain.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The identity domain description. You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// Region-agnostic identity domain URL.
	Url *string `mandatory:"true" json:"url"`

	// Region-specific identity domain URL.
	HomeRegionUrl *string `mandatory:"true" json:"homeRegionUrl"`

	// The home region for the identity domain.
	HomeRegion *string `mandatory:"true" json:"homeRegion"`

	// The regions where replicas of the identity domain exist.
	ReplicaRegions []ReplicatedRegionDetails `mandatory:"true" json:"replicaRegions"`

	// The type of the identity domain.
	Type DomainTypeEnum `mandatory:"true" json:"type"`

	// The license type of the identity domain.
	LicenseType *string `mandatory:"true" json:"licenseType"`

	// Indicates whether the identity domain is hidden on the sign-in screen or not.
	IsHiddenOnLogin *bool `mandatory:"true" json:"isHiddenOnLogin"`

	// Date and time the identity domain was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state.
	LifecycleState DomainLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Any additional details about the current state of the identity domain.
	LifecycleDetails DomainSummaryLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DomainSummary (For tenancies that support identity domains) As the name suggests, a `DomainSummary` object contains information about a `Domain`.

func (DomainSummary) String ¶

func (m DomainSummary) String() string

func (DomainSummary) ValidateEnumValue ¶

func (m DomainSummary) 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

type DomainSummaryLifecycleDetailsEnum ¶

type DomainSummaryLifecycleDetailsEnum string

DomainSummaryLifecycleDetailsEnum Enum with underlying type: string

const (
	DomainSummaryLifecycleDetailsDeactivating DomainSummaryLifecycleDetailsEnum = "DEACTIVATING"
	DomainSummaryLifecycleDetailsActivating   DomainSummaryLifecycleDetailsEnum = "ACTIVATING"
	DomainSummaryLifecycleDetailsUpdating     DomainSummaryLifecycleDetailsEnum = "UPDATING"
)

Set of constants representing the allowable values for DomainSummaryLifecycleDetailsEnum

func GetDomainSummaryLifecycleDetailsEnumValues ¶

func GetDomainSummaryLifecycleDetailsEnumValues() []DomainSummaryLifecycleDetailsEnum

GetDomainSummaryLifecycleDetailsEnumValues Enumerates the set of values for DomainSummaryLifecycleDetailsEnum

func GetMappingDomainSummaryLifecycleDetailsEnum ¶

func GetMappingDomainSummaryLifecycleDetailsEnum(val string) (DomainSummaryLifecycleDetailsEnum, bool)

GetMappingDomainSummaryLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum

type DomainTypeEnum ¶

type DomainTypeEnum string

DomainTypeEnum Enum with underlying type: string

const (
	DomainTypeDefault   DomainTypeEnum = "DEFAULT"
	DomainTypeSecondary DomainTypeEnum = "SECONDARY"
)

Set of constants representing the allowable values for DomainTypeEnum

func GetDomainTypeEnumValues ¶

func GetDomainTypeEnumValues() []DomainTypeEnum

GetDomainTypeEnumValues Enumerates the set of values for DomainTypeEnum

func GetMappingDomainTypeEnum ¶

func GetMappingDomainTypeEnum(val string) (DomainTypeEnum, bool)

GetMappingDomainTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type DynamicGroup ¶

type DynamicGroup struct {

	// The OCID of the group.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the group during creation. The name must be unique across all groups in
	// the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the group. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// A rule string that defines which instance certificates will be matched.
	// For syntax, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/dynamicgroups/managingdynamicgroups.htm).
	MatchingRule *string `mandatory:"true" json:"matchingRule"`

	// Date and time the group was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState DynamicGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DynamicGroup A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along with a few other optional properties. When an API call is made using this instance certificate as the authenticator, the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API based on the permissions granted in policies written for the dynamic groups. This works like regular user/group membership. But in that case, the membership is a static relationship, whereas in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. For more information, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/dynamicgroups/managingdynamicgroups.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (DynamicGroup) String ¶

func (m DynamicGroup) String() string

func (DynamicGroup) ValidateEnumValue ¶

func (m DynamicGroup) 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

type DynamicGroupLifecycleStateEnum ¶

type DynamicGroupLifecycleStateEnum string

DynamicGroupLifecycleStateEnum Enum with underlying type: string

const (
	DynamicGroupLifecycleStateCreating DynamicGroupLifecycleStateEnum = "CREATING"
	DynamicGroupLifecycleStateActive   DynamicGroupLifecycleStateEnum = "ACTIVE"
	DynamicGroupLifecycleStateInactive DynamicGroupLifecycleStateEnum = "INACTIVE"
	DynamicGroupLifecycleStateDeleting DynamicGroupLifecycleStateEnum = "DELETING"
	DynamicGroupLifecycleStateDeleted  DynamicGroupLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for DynamicGroupLifecycleStateEnum

func GetDynamicGroupLifecycleStateEnumValues ¶

func GetDynamicGroupLifecycleStateEnumValues() []DynamicGroupLifecycleStateEnum

GetDynamicGroupLifecycleStateEnumValues Enumerates the set of values for DynamicGroupLifecycleStateEnum

func GetMappingDynamicGroupLifecycleStateEnum ¶

func GetMappingDynamicGroupLifecycleStateEnum(val string) (DynamicGroupLifecycleStateEnum, bool)

GetMappingDynamicGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type EnableReplicationToRegionDetails ¶

type EnableReplicationToRegionDetails struct {

	// A region to which you want identity domain replication to occur.
	// See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported region names.
	// Example: `us-phoenix-1`
	ReplicaRegion *string `mandatory:"false" json:"replicaRegion"`
}

EnableReplicationToRegionDetails (For tenancies that support identity domains) Identity domain replication request packet.

func (EnableReplicationToRegionDetails) String ¶

func (EnableReplicationToRegionDetails) ValidateEnumValue ¶

func (m EnableReplicationToRegionDetails) 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

type EnableReplicationToRegionRequest ¶

type EnableReplicationToRegionRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

	// The request object for replicating the identity domain to another region.
	EnableReplicationToRegionDetails `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"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

EnableReplicationToRegionRequest wrapper for the EnableReplicationToRegion operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/EnableReplicationToRegion.go.html to see an example of how to use EnableReplicationToRegionRequest.

func (EnableReplicationToRegionRequest) BinaryRequestBody ¶

func (request EnableReplicationToRegionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (EnableReplicationToRegionRequest) HTTPRequest ¶

func (request EnableReplicationToRegionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (EnableReplicationToRegionRequest) RetryPolicy ¶

func (request EnableReplicationToRegionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (EnableReplicationToRegionRequest) String ¶

func (request EnableReplicationToRegionRequest) String() string

func (EnableReplicationToRegionRequest) ValidateEnumValue ¶

func (request EnableReplicationToRegionRequest) 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

type EnableReplicationToRegionResponse ¶

type EnableReplicationToRegionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

EnableReplicationToRegionResponse wrapper for the EnableReplicationToRegion operation

func (EnableReplicationToRegionResponse) HTTPResponse ¶

func (response EnableReplicationToRegionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (EnableReplicationToRegionResponse) String ¶

func (response EnableReplicationToRegionResponse) String() string

type EnumTagDefinitionValidator ¶

type EnumTagDefinitionValidator struct {

	// The list of allowed values for a definedTag value.
	Values []string `mandatory:"false" json:"values"`
}

EnumTagDefinitionValidator Used to validate the value set for a defined tag and contains the list of allowable `values`. You must specify at least one valid value in the `values` array. You can't have blank or or empty strings (`""`). Duplicate values are not allowed.

func (EnumTagDefinitionValidator) MarshalJSON ¶

func (m EnumTagDefinitionValidator) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (EnumTagDefinitionValidator) String ¶

func (EnumTagDefinitionValidator) ValidateEnumValue ¶

func (m EnumTagDefinitionValidator) 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

type FaultDomain ¶

type FaultDomain struct {

	// The name of the Fault Domain.
	Name *string `mandatory:"false" json:"name"`

	// The OCID of the Fault Domain.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the compartment. Currently only tenancy (root) compartment can be provided.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The name of the availabilityDomain where the Fault Domain belongs.
	AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
}

FaultDomain A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become unavailable in its entirety either due to hardware failure such as Top-of-rack (TOR) switch failure or due to planned software maintenance such as security updates that reboot your instances.

func (FaultDomain) String ¶

func (m FaultDomain) String() string

func (FaultDomain) ValidateEnumValue ¶

func (m FaultDomain) 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

type FullyQualifiedScope ¶

type FullyQualifiedScope struct {

	// Audience for the given scope context.
	Audience *string `mandatory:"true" json:"audience"`

	// Allowed permission scope for the given context.
	Scope *string `mandatory:"true" json:"scope"`
}

FullyQualifiedScope The representation of FullyQualifiedScope

func (FullyQualifiedScope) String ¶

func (m FullyQualifiedScope) String() string

func (FullyQualifiedScope) ValidateEnumValue ¶

func (m FullyQualifiedScope) 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

type GenerateTotpSeedRequest ¶

type GenerateTotpSeedRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the MFA TOTP device.
	MfaTotpDeviceId *string `mandatory:"true" contributesTo:"path" name:"mfaTotpDeviceId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

GenerateTotpSeedRequest wrapper for the GenerateTotpSeed operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GenerateTotpSeed.go.html to see an example of how to use GenerateTotpSeedRequest.

func (GenerateTotpSeedRequest) BinaryRequestBody ¶

func (request GenerateTotpSeedRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GenerateTotpSeedRequest) HTTPRequest ¶

func (request GenerateTotpSeedRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GenerateTotpSeedRequest) RetryPolicy ¶

func (request GenerateTotpSeedRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GenerateTotpSeedRequest) String ¶

func (request GenerateTotpSeedRequest) String() string

func (GenerateTotpSeedRequest) ValidateEnumValue ¶

func (request GenerateTotpSeedRequest) 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

type GenerateTotpSeedResponse ¶

type GenerateTotpSeedResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The MfaTotpDevice instance
	MfaTotpDevice `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GenerateTotpSeedResponse wrapper for the GenerateTotpSeed operation

func (GenerateTotpSeedResponse) HTTPResponse ¶

func (response GenerateTotpSeedResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GenerateTotpSeedResponse) String ¶

func (response GenerateTotpSeedResponse) String() string

type GetAuthenticationPolicyRequest ¶

type GetAuthenticationPolicyRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// 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
}

GetAuthenticationPolicyRequest wrapper for the GetAuthenticationPolicy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetAuthenticationPolicy.go.html to see an example of how to use GetAuthenticationPolicyRequest.

func (GetAuthenticationPolicyRequest) BinaryRequestBody ¶

func (request GetAuthenticationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAuthenticationPolicyRequest) HTTPRequest ¶

func (request GetAuthenticationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAuthenticationPolicyRequest) RetryPolicy ¶

func (request GetAuthenticationPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAuthenticationPolicyRequest) String ¶

func (request GetAuthenticationPolicyRequest) String() string

func (GetAuthenticationPolicyRequest) ValidateEnumValue ¶

func (request GetAuthenticationPolicyRequest) 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

type GetAuthenticationPolicyResponse ¶

type GetAuthenticationPolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AuthenticationPolicy instance
	AuthenticationPolicy `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetAuthenticationPolicyResponse wrapper for the GetAuthenticationPolicy operation

func (GetAuthenticationPolicyResponse) HTTPResponse ¶

func (response GetAuthenticationPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAuthenticationPolicyResponse) String ¶

func (response GetAuthenticationPolicyResponse) String() string

type GetCompartmentRequest ¶

type GetCompartmentRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// 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
}

GetCompartmentRequest wrapper for the GetCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetCompartment.go.html to see an example of how to use GetCompartmentRequest.

func (GetCompartmentRequest) BinaryRequestBody ¶

func (request GetCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetCompartmentRequest) HTTPRequest ¶

func (request GetCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCompartmentRequest) RetryPolicy ¶

func (request GetCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetCompartmentRequest) String ¶

func (request GetCompartmentRequest) String() string

func (GetCompartmentRequest) ValidateEnumValue ¶

func (request GetCompartmentRequest) 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

type GetCompartmentResponse ¶

type GetCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Compartment instance
	Compartment `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetCompartmentResponse wrapper for the GetCompartment operation

func (GetCompartmentResponse) HTTPResponse ¶

func (response GetCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetCompartmentResponse) String ¶

func (response GetCompartmentResponse) String() string

type GetDomainRequest ¶

type GetDomainRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

	// 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
}

GetDomainRequest wrapper for the GetDomain operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetDomain.go.html to see an example of how to use GetDomainRequest.

func (GetDomainRequest) BinaryRequestBody ¶

func (request GetDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDomainRequest) HTTPRequest ¶

func (request GetDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDomainRequest) RetryPolicy ¶

func (request GetDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDomainRequest) String ¶

func (request GetDomainRequest) String() string

func (GetDomainRequest) ValidateEnumValue ¶

func (request GetDomainRequest) 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

type GetDomainResponse ¶

type GetDomainResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Domain instance
	Domain `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetDomainResponse wrapper for the GetDomain operation

func (GetDomainResponse) HTTPResponse ¶

func (response GetDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDomainResponse) String ¶

func (response GetDomainResponse) String() string

type GetDynamicGroupRequest ¶

type GetDynamicGroupRequest struct {

	// The OCID of the dynamic group.
	DynamicGroupId *string `mandatory:"true" contributesTo:"path" name:"dynamicGroupId"`

	// 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
}

GetDynamicGroupRequest wrapper for the GetDynamicGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetDynamicGroup.go.html to see an example of how to use GetDynamicGroupRequest.

func (GetDynamicGroupRequest) BinaryRequestBody ¶

func (request GetDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDynamicGroupRequest) HTTPRequest ¶

func (request GetDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDynamicGroupRequest) RetryPolicy ¶

func (request GetDynamicGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDynamicGroupRequest) String ¶

func (request GetDynamicGroupRequest) String() string

func (GetDynamicGroupRequest) ValidateEnumValue ¶

func (request GetDynamicGroupRequest) 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

type GetDynamicGroupResponse ¶

type GetDynamicGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DynamicGroup instance
	DynamicGroup `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetDynamicGroupResponse wrapper for the GetDynamicGroup operation

func (GetDynamicGroupResponse) HTTPResponse ¶

func (response GetDynamicGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDynamicGroupResponse) String ¶

func (response GetDynamicGroupResponse) String() string

type GetGroupRequest ¶

type GetGroupRequest struct {

	// The OCID of the group.
	GroupId *string `mandatory:"true" contributesTo:"path" name:"groupId"`

	// 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
}

GetGroupRequest wrapper for the GetGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetGroup.go.html to see an example of how to use GetGroupRequest.

func (GetGroupRequest) BinaryRequestBody ¶

func (request GetGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetGroupRequest) HTTPRequest ¶

func (request GetGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetGroupRequest) RetryPolicy ¶

func (request GetGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetGroupRequest) String ¶

func (request GetGroupRequest) String() string

func (GetGroupRequest) ValidateEnumValue ¶

func (request GetGroupRequest) 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

type GetGroupResponse ¶

type GetGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Group instance
	Group `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetGroupResponse wrapper for the GetGroup operation

func (GetGroupResponse) HTTPResponse ¶

func (response GetGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetGroupResponse) String ¶

func (response GetGroupResponse) String() string

type GetIamWorkRequestRequest ¶

type GetIamWorkRequestRequest struct {

	// The OCID of the IAM work request.
	IamWorkRequestId *string `mandatory:"true" contributesTo:"path" name:"iamWorkRequestId"`

	// 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
}

GetIamWorkRequestRequest wrapper for the GetIamWorkRequest operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIamWorkRequest.go.html to see an example of how to use GetIamWorkRequestRequest.

func (GetIamWorkRequestRequest) BinaryRequestBody ¶

func (request GetIamWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetIamWorkRequestRequest) HTTPRequest ¶

func (request GetIamWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIamWorkRequestRequest) RetryPolicy ¶

func (request GetIamWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIamWorkRequestRequest) String ¶

func (request GetIamWorkRequestRequest) String() string

func (GetIamWorkRequestRequest) ValidateEnumValue ¶

func (request GetIamWorkRequestRequest) 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

type GetIamWorkRequestResponse ¶

type GetIamWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IamWorkRequest instance
	IamWorkRequest `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"`
}

GetIamWorkRequestResponse wrapper for the GetIamWorkRequest operation

func (GetIamWorkRequestResponse) HTTPResponse ¶

func (response GetIamWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIamWorkRequestResponse) String ¶

func (response GetIamWorkRequestResponse) String() string

type GetIdentityProviderRequest ¶

type GetIdentityProviderRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// 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
}

GetIdentityProviderRequest wrapper for the GetIdentityProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIdentityProvider.go.html to see an example of how to use GetIdentityProviderRequest.

func (GetIdentityProviderRequest) BinaryRequestBody ¶

func (request GetIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetIdentityProviderRequest) HTTPRequest ¶

func (request GetIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIdentityProviderRequest) RetryPolicy ¶

func (request GetIdentityProviderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIdentityProviderRequest) String ¶

func (request GetIdentityProviderRequest) String() string

func (GetIdentityProviderRequest) ValidateEnumValue ¶

func (request GetIdentityProviderRequest) 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

type GetIdentityProviderResponse ¶

type GetIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IdentityProvider instance
	IdentityProvider `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetIdentityProviderResponse wrapper for the GetIdentityProvider operation

func (GetIdentityProviderResponse) HTTPResponse ¶

func (response GetIdentityProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIdentityProviderResponse) String ¶

func (response GetIdentityProviderResponse) String() string

type GetIdpGroupMappingRequest ¶

type GetIdpGroupMappingRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// The OCID of the group mapping.
	MappingId *string `mandatory:"true" contributesTo:"path" name:"mappingId"`

	// 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
}

GetIdpGroupMappingRequest wrapper for the GetIdpGroupMapping operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIdpGroupMapping.go.html to see an example of how to use GetIdpGroupMappingRequest.

func (GetIdpGroupMappingRequest) BinaryRequestBody ¶

func (request GetIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetIdpGroupMappingRequest) HTTPRequest ¶

func (request GetIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIdpGroupMappingRequest) RetryPolicy ¶

func (request GetIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIdpGroupMappingRequest) String ¶

func (request GetIdpGroupMappingRequest) String() string

func (GetIdpGroupMappingRequest) ValidateEnumValue ¶

func (request GetIdpGroupMappingRequest) 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

type GetIdpGroupMappingResponse ¶

type GetIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IdpGroupMapping instance
	IdpGroupMapping `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetIdpGroupMappingResponse wrapper for the GetIdpGroupMapping operation

func (GetIdpGroupMappingResponse) HTTPResponse ¶

func (response GetIdpGroupMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIdpGroupMappingResponse) String ¶

func (response GetIdpGroupMappingResponse) String() string

type GetMfaTotpDeviceRequest ¶

type GetMfaTotpDeviceRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the MFA TOTP device.
	MfaTotpDeviceId *string `mandatory:"true" contributesTo:"path" name:"mfaTotpDeviceId"`

	// 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
}

GetMfaTotpDeviceRequest wrapper for the GetMfaTotpDevice operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetMfaTotpDevice.go.html to see an example of how to use GetMfaTotpDeviceRequest.

func (GetMfaTotpDeviceRequest) BinaryRequestBody ¶

func (request GetMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetMfaTotpDeviceRequest) HTTPRequest ¶

func (request GetMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetMfaTotpDeviceRequest) RetryPolicy ¶

func (request GetMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetMfaTotpDeviceRequest) String ¶

func (request GetMfaTotpDeviceRequest) String() string

func (GetMfaTotpDeviceRequest) ValidateEnumValue ¶

func (request GetMfaTotpDeviceRequest) 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

type GetMfaTotpDeviceResponse ¶

type GetMfaTotpDeviceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The MfaTotpDeviceSummary instance
	MfaTotpDeviceSummary `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetMfaTotpDeviceResponse wrapper for the GetMfaTotpDevice operation

func (GetMfaTotpDeviceResponse) HTTPResponse ¶

func (response GetMfaTotpDeviceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetMfaTotpDeviceResponse) String ¶

func (response GetMfaTotpDeviceResponse) String() string

type GetNetworkSourceRequest ¶

type GetNetworkSourceRequest struct {

	// The OCID of the network source.
	NetworkSourceId *string `mandatory:"true" contributesTo:"path" name:"networkSourceId"`

	// 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
}

GetNetworkSourceRequest wrapper for the GetNetworkSource operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetNetworkSource.go.html to see an example of how to use GetNetworkSourceRequest.

func (GetNetworkSourceRequest) BinaryRequestBody ¶

func (request GetNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetNetworkSourceRequest) HTTPRequest ¶

func (request GetNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNetworkSourceRequest) RetryPolicy ¶

func (request GetNetworkSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetNetworkSourceRequest) String ¶

func (request GetNetworkSourceRequest) String() string

func (GetNetworkSourceRequest) ValidateEnumValue ¶

func (request GetNetworkSourceRequest) 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

type GetNetworkSourceResponse ¶

type GetNetworkSourceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The NetworkSources instance
	NetworkSources `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetNetworkSourceResponse wrapper for the GetNetworkSource operation

func (GetNetworkSourceResponse) HTTPResponse ¶

func (response GetNetworkSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetNetworkSourceResponse) String ¶

func (response GetNetworkSourceResponse) String() string

type GetPolicyRequest ¶

type GetPolicyRequest struct {

	// The OCID of the policy.
	PolicyId *string `mandatory:"true" contributesTo:"path" name:"policyId"`

	// 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
}

GetPolicyRequest wrapper for the GetPolicy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetPolicy.go.html to see an example of how to use GetPolicyRequest.

func (GetPolicyRequest) BinaryRequestBody ¶

func (request GetPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetPolicyRequest) HTTPRequest ¶

func (request GetPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPolicyRequest) RetryPolicy ¶

func (request GetPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPolicyRequest) String ¶

func (request GetPolicyRequest) String() string

func (GetPolicyRequest) ValidateEnumValue ¶

func (request GetPolicyRequest) 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

type GetPolicyResponse ¶

type GetPolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Policy instance
	Policy `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetPolicyResponse wrapper for the GetPolicy operation

func (GetPolicyResponse) HTTPResponse ¶

func (response GetPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPolicyResponse) String ¶

func (response GetPolicyResponse) String() string

type GetStandardTagTemplateRequest ¶

type GetStandardTagTemplateRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the standard tag namespace tempate that is requested
	StandardTagNamespaceName *string `mandatory:"true" contributesTo:"path" name:"standardTagNamespaceName"`

	// 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
}

GetStandardTagTemplateRequest wrapper for the GetStandardTagTemplate operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetStandardTagTemplate.go.html to see an example of how to use GetStandardTagTemplateRequest.

func (GetStandardTagTemplateRequest) BinaryRequestBody ¶

func (request GetStandardTagTemplateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetStandardTagTemplateRequest) HTTPRequest ¶

func (request GetStandardTagTemplateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetStandardTagTemplateRequest) RetryPolicy ¶

func (request GetStandardTagTemplateRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetStandardTagTemplateRequest) String ¶

func (request GetStandardTagTemplateRequest) String() string

func (GetStandardTagTemplateRequest) ValidateEnumValue ¶

func (request GetStandardTagTemplateRequest) 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

type GetStandardTagTemplateResponse ¶

type GetStandardTagTemplateResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The StandardTagNamespaceTemplate instance
	StandardTagNamespaceTemplate `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"`
}

GetStandardTagTemplateResponse wrapper for the GetStandardTagTemplate operation

func (GetStandardTagTemplateResponse) HTTPResponse ¶

func (response GetStandardTagTemplateResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetStandardTagTemplateResponse) String ¶

func (response GetStandardTagTemplateResponse) String() string

type GetTagDefaultRequest ¶

type GetTagDefaultRequest struct {

	// The OCID of the tag default.
	TagDefaultId *string `mandatory:"true" contributesTo:"path" name:"tagDefaultId"`

	// 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
}

GetTagDefaultRequest wrapper for the GetTagDefault operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTagDefault.go.html to see an example of how to use GetTagDefaultRequest.

func (GetTagDefaultRequest) BinaryRequestBody ¶

func (request GetTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTagDefaultRequest) HTTPRequest ¶

func (request GetTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTagDefaultRequest) RetryPolicy ¶

func (request GetTagDefaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTagDefaultRequest) String ¶

func (request GetTagDefaultRequest) String() string

func (GetTagDefaultRequest) ValidateEnumValue ¶

func (request GetTagDefaultRequest) 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

type GetTagDefaultResponse ¶

type GetTagDefaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagDefault instance
	TagDefault `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetTagDefaultResponse wrapper for the GetTagDefault operation

func (GetTagDefaultResponse) HTTPResponse ¶

func (response GetTagDefaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTagDefaultResponse) String ¶

func (response GetTagDefaultResponse) String() string

type GetTagNamespaceRequest ¶

type GetTagNamespaceRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// 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
}

GetTagNamespaceRequest wrapper for the GetTagNamespace operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTagNamespace.go.html to see an example of how to use GetTagNamespaceRequest.

func (GetTagNamespaceRequest) BinaryRequestBody ¶

func (request GetTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTagNamespaceRequest) HTTPRequest ¶

func (request GetTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTagNamespaceRequest) RetryPolicy ¶

func (request GetTagNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTagNamespaceRequest) String ¶

func (request GetTagNamespaceRequest) String() string

func (GetTagNamespaceRequest) ValidateEnumValue ¶

func (request GetTagNamespaceRequest) 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

type GetTagNamespaceResponse ¶

type GetTagNamespaceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagNamespace instance
	TagNamespace `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"`
}

GetTagNamespaceResponse wrapper for the GetTagNamespace operation

func (GetTagNamespaceResponse) HTTPResponse ¶

func (response GetTagNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTagNamespaceResponse) String ¶

func (response GetTagNamespaceResponse) String() string

type GetTagRequest ¶

type GetTagRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// The name of the tag.
	TagName *string `mandatory:"true" contributesTo:"path" name:"tagName"`

	// 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
}

GetTagRequest wrapper for the GetTag operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTag.go.html to see an example of how to use GetTagRequest.

func (GetTagRequest) BinaryRequestBody ¶

func (request GetTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTagRequest) HTTPRequest ¶

func (request GetTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTagRequest) RetryPolicy ¶

func (request GetTagRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTagRequest) String ¶

func (request GetTagRequest) String() string

func (GetTagRequest) ValidateEnumValue ¶

func (request GetTagRequest) 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

type GetTagResponse ¶

type GetTagResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Tag instance
	Tag `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetTagResponse wrapper for the GetTag operation

func (GetTagResponse) HTTPResponse ¶

func (response GetTagResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTagResponse) String ¶

func (response GetTagResponse) String() string

type GetTaggingWorkRequestRequest ¶

type GetTaggingWorkRequestRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// 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
}

GetTaggingWorkRequestRequest wrapper for the GetTaggingWorkRequest operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTaggingWorkRequest.go.html to see an example of how to use GetTaggingWorkRequestRequest.

func (GetTaggingWorkRequestRequest) BinaryRequestBody ¶

func (request GetTaggingWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTaggingWorkRequestRequest) HTTPRequest ¶

func (request GetTaggingWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTaggingWorkRequestRequest) RetryPolicy ¶

func (request GetTaggingWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTaggingWorkRequestRequest) String ¶

func (request GetTaggingWorkRequestRequest) String() string

func (GetTaggingWorkRequestRequest) ValidateEnumValue ¶

func (request GetTaggingWorkRequestRequest) 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

type GetTaggingWorkRequestResponse ¶

type GetTaggingWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TaggingWorkRequest instance
	TaggingWorkRequest `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"`

	// The number of seconds that the client should wait before polling again.
	RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

GetTaggingWorkRequestResponse wrapper for the GetTaggingWorkRequest operation

func (GetTaggingWorkRequestResponse) HTTPResponse ¶

func (response GetTaggingWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTaggingWorkRequestResponse) String ¶

func (response GetTaggingWorkRequestResponse) String() string

type GetTenancyRequest ¶

type GetTenancyRequest struct {

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"path" name:"tenancyId"`

	// 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
}

GetTenancyRequest wrapper for the GetTenancy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTenancy.go.html to see an example of how to use GetTenancyRequest.

func (GetTenancyRequest) BinaryRequestBody ¶

func (request GetTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTenancyRequest) HTTPRequest ¶

func (request GetTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTenancyRequest) RetryPolicy ¶

func (request GetTenancyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTenancyRequest) String ¶

func (request GetTenancyRequest) String() string

func (GetTenancyRequest) ValidateEnumValue ¶

func (request GetTenancyRequest) 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

type GetTenancyResponse ¶

type GetTenancyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Tenancy instance
	Tenancy `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"`
}

GetTenancyResponse wrapper for the GetTenancy operation

func (GetTenancyResponse) HTTPResponse ¶

func (response GetTenancyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTenancyResponse) String ¶

func (response GetTenancyResponse) String() string

type GetUserGroupMembershipRequest ¶

type GetUserGroupMembershipRequest struct {

	// The OCID of the userGroupMembership.
	UserGroupMembershipId *string `mandatory:"true" contributesTo:"path" name:"userGroupMembershipId"`

	// 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
}

GetUserGroupMembershipRequest wrapper for the GetUserGroupMembership operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUserGroupMembership.go.html to see an example of how to use GetUserGroupMembershipRequest.

func (GetUserGroupMembershipRequest) BinaryRequestBody ¶

func (request GetUserGroupMembershipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetUserGroupMembershipRequest) HTTPRequest ¶

func (request GetUserGroupMembershipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUserGroupMembershipRequest) RetryPolicy ¶

func (request GetUserGroupMembershipRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetUserGroupMembershipRequest) String ¶

func (request GetUserGroupMembershipRequest) String() string

func (GetUserGroupMembershipRequest) ValidateEnumValue ¶

func (request GetUserGroupMembershipRequest) 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

type GetUserGroupMembershipResponse ¶

type GetUserGroupMembershipResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The UserGroupMembership instance
	UserGroupMembership `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetUserGroupMembershipResponse wrapper for the GetUserGroupMembership operation

func (GetUserGroupMembershipResponse) HTTPResponse ¶

func (response GetUserGroupMembershipResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetUserGroupMembershipResponse) String ¶

func (response GetUserGroupMembershipResponse) String() string

type GetUserRequest ¶

type GetUserRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

GetUserRequest wrapper for the GetUser operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUser.go.html to see an example of how to use GetUserRequest.

func (GetUserRequest) BinaryRequestBody ¶

func (request GetUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetUserRequest) HTTPRequest ¶

func (request GetUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUserRequest) RetryPolicy ¶

func (request GetUserRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetUserRequest) String ¶

func (request GetUserRequest) String() string

func (GetUserRequest) ValidateEnumValue ¶

func (request GetUserRequest) 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

type GetUserResponse ¶

type GetUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetUserResponse wrapper for the GetUser operation

func (GetUserResponse) HTTPResponse ¶

func (response GetUserResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetUserResponse) String ¶

func (response GetUserResponse) String() string

type GetUserUIPasswordInformationRequest ¶

type GetUserUIPasswordInformationRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

GetUserUIPasswordInformationRequest wrapper for the GetUserUIPasswordInformation operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUserUIPasswordInformation.go.html to see an example of how to use GetUserUIPasswordInformationRequest.

func (GetUserUIPasswordInformationRequest) BinaryRequestBody ¶

func (request GetUserUIPasswordInformationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetUserUIPasswordInformationRequest) HTTPRequest ¶

func (request GetUserUIPasswordInformationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUserUIPasswordInformationRequest) RetryPolicy ¶

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetUserUIPasswordInformationRequest) String ¶

func (GetUserUIPasswordInformationRequest) ValidateEnumValue ¶

func (request GetUserUIPasswordInformationRequest) 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

type GetUserUIPasswordInformationResponse ¶

type GetUserUIPasswordInformationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The UiPasswordInformation instance
	UiPasswordInformation `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetUserUIPasswordInformationResponse wrapper for the GetUserUIPasswordInformation operation

func (GetUserUIPasswordInformationResponse) HTTPResponse ¶

func (response GetUserUIPasswordInformationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetUserUIPasswordInformationResponse) String ¶

func (response GetUserUIPasswordInformationResponse) String() string

type GetWorkRequestRequest ¶

type GetWorkRequestRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody ¶

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest ¶

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy ¶

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String ¶

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue ¶

func (request GetWorkRequestRequest) 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

type GetWorkRequestResponse ¶

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `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"`

	// The number of seconds that the client should wait before polling again.
	RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse ¶

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String ¶

func (response GetWorkRequestResponse) String() string

type Group ¶

type Group struct {

	// The OCID of the group.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the group during creation. The name must be unique across all groups in
	// the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the group. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// Date and time the group was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState GroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Group A collection of users who all need the same type of access to a particular set of resources or compartment. For conceptual information about groups and other IAM Service components, see Overview of IAM (https://docs.cloud.oracle.com/Content/Identity/getstarted/identity-domains.htm). If you're federating with an identity provider (IdP), you need to create mappings between the groups defined in the IdP and groups you define in the IAM service. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). Also see IdentityProvider and IdpGroupMapping. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Group) String ¶

func (m Group) String() string

func (Group) ValidateEnumValue ¶

func (m Group) 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

type GroupLifecycleStateEnum ¶

type GroupLifecycleStateEnum string

GroupLifecycleStateEnum Enum with underlying type: string

const (
	GroupLifecycleStateCreating GroupLifecycleStateEnum = "CREATING"
	GroupLifecycleStateActive   GroupLifecycleStateEnum = "ACTIVE"
	GroupLifecycleStateInactive GroupLifecycleStateEnum = "INACTIVE"
	GroupLifecycleStateDeleting GroupLifecycleStateEnum = "DELETING"
	GroupLifecycleStateDeleted  GroupLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for GroupLifecycleStateEnum

func GetGroupLifecycleStateEnumValues ¶

func GetGroupLifecycleStateEnumValues() []GroupLifecycleStateEnum

GetGroupLifecycleStateEnumValues Enumerates the set of values for GroupLifecycleStateEnum

func GetMappingGroupLifecycleStateEnum ¶

func GetMappingGroupLifecycleStateEnum(val string) (GroupLifecycleStateEnum, bool)

GetMappingGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type IamWorkRequest ¶

type IamWorkRequest struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The asynchronous operation tracked by this IAM work request.
	OperationType IamWorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status IamWorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment containing this IAM work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []IamWorkRequestResource `mandatory:"false" json:"resources"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

IamWorkRequest (For tenancies that support identity domains) An IAM work request object that allows users to track the status of asynchronous API requests.

func (IamWorkRequest) String ¶

func (m IamWorkRequest) String() string

func (IamWorkRequest) ValidateEnumValue ¶

func (m IamWorkRequest) 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

type IamWorkRequestErrorSummary ¶

type IamWorkRequestErrorSummary struct {

	// A machine-usable code for the error that occured.
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the error occurred.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

IamWorkRequestErrorSummary (For tenancies that support identity domains) An error encountered while executing an operation that is tracked by a IAM work request.

func (IamWorkRequestErrorSummary) String ¶

func (IamWorkRequestErrorSummary) ValidateEnumValue ¶

func (m IamWorkRequestErrorSummary) 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

type IamWorkRequestLogSummary ¶

type IamWorkRequestLogSummary struct {

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the log was written, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

IamWorkRequestLogSummary (For tenancies that support identity domains) The log entity for a IAM work request.

func (IamWorkRequestLogSummary) String ¶

func (m IamWorkRequestLogSummary) String() string

func (IamWorkRequestLogSummary) ValidateEnumValue ¶

func (m IamWorkRequestLogSummary) 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

type IamWorkRequestOperationTypeEnum ¶

type IamWorkRequestOperationTypeEnum string

IamWorkRequestOperationTypeEnum Enum with underlying type: string

const (
	IamWorkRequestOperationTypeCreateDomain               IamWorkRequestOperationTypeEnum = "CREATE_DOMAIN"
	IamWorkRequestOperationTypeReplicateDomainToRegion    IamWorkRequestOperationTypeEnum = "REPLICATE_DOMAIN_TO_REGION"
	IamWorkRequestOperationTypeUpdateDomain               IamWorkRequestOperationTypeEnum = "UPDATE_DOMAIN"
	IamWorkRequestOperationTypeActivateDomain             IamWorkRequestOperationTypeEnum = "ACTIVATE_DOMAIN"
	IamWorkRequestOperationTypeDeactivateDomain           IamWorkRequestOperationTypeEnum = "DEACTIVATE_DOMAIN"
	IamWorkRequestOperationTypeDeleteDomain               IamWorkRequestOperationTypeEnum = "DELETE_DOMAIN"
	IamWorkRequestOperationTypeChangeCompartmentForDomain IamWorkRequestOperationTypeEnum = "CHANGE_COMPARTMENT_FOR_DOMAIN"
	IamWorkRequestOperationTypeChangeLicenseTypeForDomain IamWorkRequestOperationTypeEnum = "CHANGE_LICENSE_TYPE_FOR_DOMAIN"
)

Set of constants representing the allowable values for IamWorkRequestOperationTypeEnum

func GetIamWorkRequestOperationTypeEnumValues ¶

func GetIamWorkRequestOperationTypeEnumValues() []IamWorkRequestOperationTypeEnum

GetIamWorkRequestOperationTypeEnumValues Enumerates the set of values for IamWorkRequestOperationTypeEnum

func GetMappingIamWorkRequestOperationTypeEnum ¶

func GetMappingIamWorkRequestOperationTypeEnum(val string) (IamWorkRequestOperationTypeEnum, bool)

GetMappingIamWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type IamWorkRequestResource ¶

type IamWorkRequestResource struct {

	// The way in which this resource is affected by the work tracked in the work request.
	// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
	// work is complete for that resource at which point it will transition to CREATED, UPDATED,
	// or DELETED, respectively.
	ActionType IamWorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

	// The resource type the work request is affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// An OCID of the resource that the work request affects.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path that the user can do a GET on to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`
}

IamWorkRequestResource (For tenancies that support identity domains) A IAM work request resource entry.

func (IamWorkRequestResource) String ¶

func (m IamWorkRequestResource) String() string

func (IamWorkRequestResource) ValidateEnumValue ¶

func (m IamWorkRequestResource) 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

type IamWorkRequestResourceActionTypeEnum ¶

type IamWorkRequestResourceActionTypeEnum string

IamWorkRequestResourceActionTypeEnum Enum with underlying type: string

const (
	IamWorkRequestResourceActionTypeCreated    IamWorkRequestResourceActionTypeEnum = "CREATED"
	IamWorkRequestResourceActionTypeUpdated    IamWorkRequestResourceActionTypeEnum = "UPDATED"
	IamWorkRequestResourceActionTypeDeleted    IamWorkRequestResourceActionTypeEnum = "DELETED"
	IamWorkRequestResourceActionTypeRelated    IamWorkRequestResourceActionTypeEnum = "RELATED"
	IamWorkRequestResourceActionTypeInProgress IamWorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)

Set of constants representing the allowable values for IamWorkRequestResourceActionTypeEnum

func GetIamWorkRequestResourceActionTypeEnumValues ¶

func GetIamWorkRequestResourceActionTypeEnumValues() []IamWorkRequestResourceActionTypeEnum

GetIamWorkRequestResourceActionTypeEnumValues Enumerates the set of values for IamWorkRequestResourceActionTypeEnum

func GetMappingIamWorkRequestResourceActionTypeEnum ¶

func GetMappingIamWorkRequestResourceActionTypeEnum(val string) (IamWorkRequestResourceActionTypeEnum, bool)

GetMappingIamWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type IamWorkRequestStatusEnum ¶

type IamWorkRequestStatusEnum string

IamWorkRequestStatusEnum Enum with underlying type: string

const (
	IamWorkRequestStatusAccepted   IamWorkRequestStatusEnum = "ACCEPTED"
	IamWorkRequestStatusInProgress IamWorkRequestStatusEnum = "IN_PROGRESS"
	IamWorkRequestStatusFailed     IamWorkRequestStatusEnum = "FAILED"
	IamWorkRequestStatusSucceeded  IamWorkRequestStatusEnum = "SUCCEEDED"
	IamWorkRequestStatusCanceling  IamWorkRequestStatusEnum = "CANCELING"
	IamWorkRequestStatusCanceled   IamWorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for IamWorkRequestStatusEnum

func GetIamWorkRequestStatusEnumValues ¶

func GetIamWorkRequestStatusEnumValues() []IamWorkRequestStatusEnum

GetIamWorkRequestStatusEnumValues Enumerates the set of values for IamWorkRequestStatusEnum

func GetMappingIamWorkRequestStatusEnum ¶

func GetMappingIamWorkRequestStatusEnum(val string) (IamWorkRequestStatusEnum, bool)

GetMappingIamWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type IamWorkRequestSummary ¶

type IamWorkRequestSummary struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The asynchronous operation tracked by this IAM work request.
	OperationType IamWorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status IamWorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment containing this IAM work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []IamWorkRequestResource `mandatory:"false" json:"resources"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

IamWorkRequestSummary (For tenancies that support identity domains) The IAM work request summary. Tracks the status of asynchronous operations.

func (IamWorkRequestSummary) String ¶

func (m IamWorkRequestSummary) String() string

func (IamWorkRequestSummary) ValidateEnumValue ¶

func (m IamWorkRequestSummary) 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

type IamWorkRequestSummaryOperationTypeEnum ¶

type IamWorkRequestSummaryOperationTypeEnum string

IamWorkRequestSummaryOperationTypeEnum Enum with underlying type: string

const (
	IamWorkRequestSummaryOperationTypeCreateDomain               IamWorkRequestSummaryOperationTypeEnum = "CREATE_DOMAIN"
	IamWorkRequestSummaryOperationTypeReplicateDomainToRegion    IamWorkRequestSummaryOperationTypeEnum = "REPLICATE_DOMAIN_TO_REGION"
	IamWorkRequestSummaryOperationTypeUpdateDomain               IamWorkRequestSummaryOperationTypeEnum = "UPDATE_DOMAIN"
	IamWorkRequestSummaryOperationTypeActivateDomain             IamWorkRequestSummaryOperationTypeEnum = "ACTIVATE_DOMAIN"
	IamWorkRequestSummaryOperationTypeDeactivateDomain           IamWorkRequestSummaryOperationTypeEnum = "DEACTIVATE_DOMAIN"
	IamWorkRequestSummaryOperationTypeDeleteDomain               IamWorkRequestSummaryOperationTypeEnum = "DELETE_DOMAIN"
	IamWorkRequestSummaryOperationTypeChangeCompartmentForDomain IamWorkRequestSummaryOperationTypeEnum = "CHANGE_COMPARTMENT_FOR_DOMAIN"
	IamWorkRequestSummaryOperationTypeChangeLicenseTypeForDomain IamWorkRequestSummaryOperationTypeEnum = "CHANGE_LICENSE_TYPE_FOR_DOMAIN"
)

Set of constants representing the allowable values for IamWorkRequestSummaryOperationTypeEnum

func GetIamWorkRequestSummaryOperationTypeEnumValues ¶

func GetIamWorkRequestSummaryOperationTypeEnumValues() []IamWorkRequestSummaryOperationTypeEnum

GetIamWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for IamWorkRequestSummaryOperationTypeEnum

func GetMappingIamWorkRequestSummaryOperationTypeEnum ¶

func GetMappingIamWorkRequestSummaryOperationTypeEnum(val string) (IamWorkRequestSummaryOperationTypeEnum, bool)

GetMappingIamWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type IamWorkRequestSummaryStatusEnum ¶

type IamWorkRequestSummaryStatusEnum string

IamWorkRequestSummaryStatusEnum Enum with underlying type: string

const (
	IamWorkRequestSummaryStatusAccepted   IamWorkRequestSummaryStatusEnum = "ACCEPTED"
	IamWorkRequestSummaryStatusInProgress IamWorkRequestSummaryStatusEnum = "IN_PROGRESS"
	IamWorkRequestSummaryStatusFailed     IamWorkRequestSummaryStatusEnum = "FAILED"
	IamWorkRequestSummaryStatusSucceeded  IamWorkRequestSummaryStatusEnum = "SUCCEEDED"
	IamWorkRequestSummaryStatusCanceling  IamWorkRequestSummaryStatusEnum = "CANCELING"
	IamWorkRequestSummaryStatusCanceled   IamWorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for IamWorkRequestSummaryStatusEnum

func GetIamWorkRequestSummaryStatusEnumValues ¶

func GetIamWorkRequestSummaryStatusEnumValues() []IamWorkRequestSummaryStatusEnum

GetIamWorkRequestSummaryStatusEnumValues Enumerates the set of values for IamWorkRequestSummaryStatusEnum

func GetMappingIamWorkRequestSummaryStatusEnum ¶

func GetMappingIamWorkRequestSummaryStatusEnum(val string) (IamWorkRequestSummaryStatusEnum, bool)

GetMappingIamWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type IdentityClient ¶

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

IdentityClient a client for Identity

func NewIdentityClientWithConfigurationProvider ¶

func NewIdentityClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client IdentityClient, err error)

NewIdentityClientWithConfigurationProvider Creates a new default Identity client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewIdentityClientWithOboToken ¶

func NewIdentityClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client IdentityClient, err error)

NewIdentityClientWithOboToken Creates a new default Identity 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 (IdentityClient) ActivateDomain ¶

func (client IdentityClient) ActivateDomain(ctx context.Context, request ActivateDomainRequest) (response ActivateDomainResponse, err error)

ActivateDomain (For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of. After you send the request, the `lifecycleDetails` of the identity domain is set to ACTIVATING. When the operation completes, the `lifecycleDetails` is set to null and the `lifecycleState` of the identity domain is set to ACTIVE. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ActivateDomain.go.html to see an example of how to use ActivateDomain API. A default retry strategy applies to this operation ActivateDomain()

func (IdentityClient) ActivateMfaTotpDevice ¶

func (client IdentityClient) ActivateMfaTotpDevice(ctx context.Context, request ActivateMfaTotpDeviceRequest) (response ActivateMfaTotpDeviceResponse, err error)

ActivateMfaTotpDevice Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ActivateMfaTotpDevice.go.html to see an example of how to use ActivateMfaTotpDevice API. A default retry strategy applies to this operation ActivateMfaTotpDevice()

func (IdentityClient) AddTagDefaultLock ¶ added in v65.9.0

func (client IdentityClient) AddTagDefaultLock(ctx context.Context, request AddTagDefaultLockRequest) (response AddTagDefaultLockResponse, err error)

AddTagDefaultLock Add a resource lock to a tag default.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddTagDefaultLock.go.html to see an example of how to use AddTagDefaultLock API. A default retry strategy applies to this operation AddTagDefaultLock()

func (IdentityClient) AddTagNamespaceLock ¶ added in v65.9.0

func (client IdentityClient) AddTagNamespaceLock(ctx context.Context, request AddTagNamespaceLockRequest) (response AddTagNamespaceLockResponse, err error)

AddTagNamespaceLock Add a resource lock to a tag namespace.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddTagNamespaceLock.go.html to see an example of how to use AddTagNamespaceLock API. A default retry strategy applies to this operation AddTagNamespaceLock()

func (IdentityClient) AddUserToGroup ¶

func (client IdentityClient) AddUserToGroup(ctx context.Context, request AddUserToGroupRequest) (response AddUserToGroupResponse, err error)

AddUserToGroup Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddUserToGroup.go.html to see an example of how to use AddUserToGroup API. A default retry strategy applies to this operation AddUserToGroup()

func (IdentityClient) AssembleEffectiveTagSet ¶

func (client IdentityClient) AssembleEffectiveTagSet(ctx context.Context, request AssembleEffectiveTagSetRequest) (response AssembleEffectiveTagSetResponse, err error)

AssembleEffectiveTagSet Assembles tag defaults in the specified compartment and any parent compartments to determine the tags to apply. Tag defaults from parent compartments do not override tag defaults referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults includes all tag defaults from the current compartment back to the root compartment.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AssembleEffectiveTagSet.go.html to see an example of how to use AssembleEffectiveTagSet API. A default retry strategy applies to this operation AssembleEffectiveTagSet()

func (IdentityClient) BulkDeleteResources ¶

func (client IdentityClient) BulkDeleteResources(ctx context.Context, request BulkDeleteResourcesRequest) (response BulkDeleteResourcesResponse, err error)

BulkDeleteResources Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate permissions to delete the resources in the request. This API can only be invoked from the tenancy's home region (https://docs.cloud.oracle.com/Content/Identity/regions/managingregions.htm#Home). This operation creates a WorkRequest. Use the GetWorkRequest API to monitor the status of the bulk action.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkDeleteResources.go.html to see an example of how to use BulkDeleteResources API. A default retry strategy applies to this operation BulkDeleteResources()

func (IdentityClient) BulkDeleteTags ¶

func (client IdentityClient) BulkDeleteTags(ctx context.Context, request BulkDeleteTagsRequest) (response BulkDeleteTagsResponse, err error)

BulkDeleteTags Deletes the specified tag key definitions. This operation triggers a process that removes the tags from all resources in your tenancy. The tag key definitions must be within the same tag namespace. The following actions happen immediately:

  • If the tag is a cost-tracking tag, the tag no longer counts against your 10 cost-tracking tags limit, even if you do not disable the tag before running this operation.
  • If the tag is used with dynamic groups, the rules that contain the tag are no longer evaluated against the tag.

After you start this operation, the state of the tag changes to DELETING, and tag removal from resources begins. This process can take up to 48 hours depending on the number of resources that are tagged and the regions in which those resources reside. When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state changes to DELETED, you can use the same tag name again. After you start this operation, you cannot start either the DeleteTag or the CascadeDeleteTagNamespace operation until this process completes. In order to delete tags, you must first retire the tags. Use UpdateTag to retire a tag.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkDeleteTags.go.html to see an example of how to use BulkDeleteTags API. A default retry strategy applies to this operation BulkDeleteTags()

func (IdentityClient) BulkEditTags ¶

func (client IdentityClient) BulkEditTags(ctx context.Context, request BulkEditTagsRequest) (response BulkEditTagsResponse, err error)

BulkEditTags Edits the specified list of tag key definitions for the selected resources. This operation triggers a process that edits the tags on all selected resources. The possible actions are:

  • Add a defined tag when the tag does not already exist on the resource.
  • Update the value for a defined tag when the tag is present on the resource.
  • Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource.
  • Remove a defined tag from a resource. The tag is removed from the resource regardless of the tag value.

See BulkEditOperationDetails for more information. The edits can include a combination of operations and tag sets. However, multiple operations cannot apply to one key definition in the same request. For example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`, `tag set-1` and `tag set-2` cannot have any common tag definitions.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkEditTags.go.html to see an example of how to use BulkEditTags API. A default retry strategy applies to this operation BulkEditTags()

func (IdentityClient) BulkMoveResources ¶

func (client IdentityClient) BulkMoveResources(ctx context.Context, request BulkMoveResourcesRequest) (response BulkMoveResourcesResponse, err error)

BulkMoveResources Moves multiple resources from one compartment to another. All resources must be in the same compartment. This API can only be invoked from the tenancy's home region (https://docs.cloud.oracle.com/Content/Identity/regions/managingregions.htm#Home). To move resources, you must have the appropriate permissions to move the resource in both the source and target compartments. This operation creates a WorkRequest. Use the GetWorkRequest API to monitor the status of the bulk action.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkMoveResources.go.html to see an example of how to use BulkMoveResources API. A default retry strategy applies to this operation BulkMoveResources()

func (IdentityClient) CascadeDeleteTagNamespace ¶

func (client IdentityClient) CascadeDeleteTagNamespace(ctx context.Context, request CascadeDeleteTagNamespaceRequest) (response CascadeDeleteTagNamespaceResponse, err error)

CascadeDeleteTagNamespace Deletes the specified tag namespace. This operation triggers a process that removes all of the tags defined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace. After you start the delete operation:

  • New tag key definitions cannot be created under the namespace.
  • The state of the tag namespace changes to DELETING.
  • Tag removal from the resources begins.

This process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources that are tagged, and the locations of the regions in which those resources reside. After all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace changes its state to DELETED, you can use the name of the deleted tag namespace again. After you start this operation, you cannot start either the DeleteTag or the BulkDeleteTags operation until this process completes. To delete a tag namespace, you must first retire it. Use UpdateTagNamespace to retire a tag namespace.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CascadeDeleteTagNamespace.go.html to see an example of how to use CascadeDeleteTagNamespace API. A default retry strategy applies to this operation CascadeDeleteTagNamespace()

func (IdentityClient) ChangeDomainCompartment ¶

func (client IdentityClient) ChangeDomainCompartment(ctx context.Context, request ChangeDomainCompartmentRequest) (response ChangeDomainCompartmentResponse, err error)

ChangeDomainCompartment (For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeDomainCompartment.go.html to see an example of how to use ChangeDomainCompartment API. A default retry strategy applies to this operation ChangeDomainCompartment()

func (IdentityClient) ChangeDomainLicenseType ¶

func (client IdentityClient) ChangeDomainLicenseType(ctx context.Context, request ChangeDomainLicenseTypeRequest) (response ChangeDomainLicenseTypeResponse, err error)

ChangeDomainLicenseType (For tenancies that support identity domains) Changes the license type of the given identity domain. The identity domain's `lifecycleState` must be set to ACTIVE and the requested `licenseType` must be allowed. To retrieve the allowed `licenseType` for the identity domain, use ListAllowedDomainLicenseTypes. After you send your request, the `lifecycleDetails` of this identity domain is set to UPDATING. When the update of the identity domain completes, then the `lifecycleDetails` is set to null. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeDomainLicenseType.go.html to see an example of how to use ChangeDomainLicenseType API. A default retry strategy applies to this operation ChangeDomainLicenseType()

func (IdentityClient) ChangeTagNamespaceCompartment ¶

func (client IdentityClient) ChangeTagNamespaceCompartment(ctx context.Context, request ChangeTagNamespaceCompartmentRequest) (response ChangeTagNamespaceCompartmentResponse, err error)

ChangeTagNamespaceCompartment Moves the specified tag namespace to the specified compartment within the same tenancy. To move the tag namespace, you must have the manage tag-namespaces permission on both compartments. For more information about IAM policies, see Details for IAM (https://docs.cloud.oracle.com/Content/Identity/policyreference/iampolicyreference.htm). Moving a tag namespace moves all the tag key definitions contained in the tag namespace.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeTagNamespaceCompartment.go.html to see an example of how to use ChangeTagNamespaceCompartment API. A default retry strategy applies to this operation ChangeTagNamespaceCompartment()

func (*IdentityClient) ConfigurationProvider ¶

func (client *IdentityClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (IdentityClient) CreateAuthToken ¶

func (client IdentityClient) CreateAuthToken(ctx context.Context, request CreateAuthTokenRequest) (response CreateAuthTokenResponse, err error)

CreateAuthToken Creates a new auth token for the specified user. For information about what auth tokens are for, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm). You must specify a *description* for the auth token (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateAuthToken. Every user has permission to create an auth token for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create an auth token for any user, including themselves.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateAuthToken.go.html to see an example of how to use CreateAuthToken API. A default retry strategy applies to this operation CreateAuthToken()

func (IdentityClient) CreateCompartment ¶

func (client IdentityClient) CreateCompartment(ctx context.Context, request CreateCompartmentRequest) (response CreateCompartmentResponse, err error)

CreateCompartment Creates a new compartment in the specified compartment. Specify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the compartment, which must be unique across all compartments in your tenancy. You can use this name or the OCID when writing policies that apply to the compartment. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm). You must also specify a *description* for the compartment (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateCompartment. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateCompartment.go.html to see an example of how to use CreateCompartment API. A default retry strategy applies to this operation CreateCompartment()

func (IdentityClient) CreateCustomerSecretKey ¶

func (client IdentityClient) CreateCustomerSecretKey(ctx context.Context, request CreateCustomerSecretKeyRequest) (response CreateCustomerSecretKeyResponse, err error)

CreateCustomerSecretKey Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3 compatible API. The secret key consists of an Access Key/Secret Key pair. For information, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm). You must specify a *description* for the secret key (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateCustomerSecretKey. Every user has permission to create a secret key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a secret key for any user, including themselves.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateCustomerSecretKey.go.html to see an example of how to use CreateCustomerSecretKey API. A default retry strategy applies to this operation CreateCustomerSecretKey()

func (IdentityClient) CreateDbCredential ¶

func (client IdentityClient) CreateDbCredential(ctx context.Context, request CreateDbCredentialRequest) (response CreateDbCredentialResponse, err error)

CreateDbCredential Creates a new DB credential for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDbCredential.go.html to see an example of how to use CreateDbCredential API. A default retry strategy applies to this operation CreateDbCredential()

func (IdentityClient) CreateDomain ¶

func (client IdentityClient) CreateDomain(ctx context.Context, request CreateDomainRequest) (response CreateDomainResponse, err error)

CreateDomain (For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in `homeRegion`. After you send your request, the temporary `lifecycleState` of this identity domain is set to CREATING and `lifecycleDetails` to UPDATING. When creation of the identity domain completes, this identity domain's `lifecycleState` is set to ACTIVE and `lifecycleDetails` to null. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status. After creating an `identity domain`, first make sure its `lifecycleState` changes from CREATING to ACTIVE before you use it.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDomain.go.html to see an example of how to use CreateDomain API. A default retry strategy applies to this operation CreateDomain()

func (IdentityClient) CreateDynamicGroup ¶

func (client IdentityClient) CreateDynamicGroup(ctx context.Context, request CreateDynamicGroupRequest) (response CreateDynamicGroupResponse, err error)

CreateDynamicGroup Creates a new dynamic group in your tenancy. You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. You can use this name or the OCID when writing policies that apply to the dynamic group. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm). You must also specify a *description* for the dynamic group (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateDynamicGroup. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDynamicGroup.go.html to see an example of how to use CreateDynamicGroup API. A default retry strategy applies to this operation CreateDynamicGroup()

func (IdentityClient) CreateGroup ¶

func (client IdentityClient) CreateGroup(ctx context.Context, request CreateGroupRequest) (response CreateGroupResponse, err error)

CreateGroup Creates a new group in your tenancy. You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the group, which must be unique across all groups in your tenancy and cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm). You must also specify a *description* for the group (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateGroup. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. After creating the group, you need to put users in it and write policies for it. See AddUserToGroup and CreatePolicy.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateGroup.go.html to see an example of how to use CreateGroup API. A default retry strategy applies to this operation CreateGroup()

func (IdentityClient) CreateIdentityProvider ¶

func (client IdentityClient) CreateIdentityProvider(ctx context.Context, request CreateIdentityProviderRequest) (response CreateIdentityProviderResponse, err error)

CreateIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Creates a new identity provider in your tenancy. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). You must specify your tenancy's OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the `IdentityProvider`, which must be unique across all `IdentityProvider` objects in your tenancy and cannot be changed. You must also specify a *description* for the `IdentityProvider` (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateIdentityProvider. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateIdentityProvider.go.html to see an example of how to use CreateIdentityProvider API. A default retry strategy applies to this operation CreateIdentityProvider()

func (IdentityClient) CreateIdpGroupMapping ¶

func (client IdentityClient) CreateIdpGroupMapping(ctx context.Context, request CreateIdpGroupMappingRequest) (response CreateIdpGroupMappingResponse, err error)

CreateIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Creates a single mapping between an IdP group and an IAM Service Group.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateIdpGroupMapping.go.html to see an example of how to use CreateIdpGroupMapping API. A default retry strategy applies to this operation CreateIdpGroupMapping()

func (IdentityClient) CreateMfaTotpDevice ¶

func (client IdentityClient) CreateMfaTotpDevice(ctx context.Context, request CreateMfaTotpDeviceRequest) (response CreateMfaTotpDeviceResponse, err error)

CreateMfaTotpDevice Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateMfaTotpDevice.go.html to see an example of how to use CreateMfaTotpDevice API. A default retry strategy applies to this operation CreateMfaTotpDevice()

func (IdentityClient) CreateNetworkSource ¶

func (client IdentityClient) CreateNetworkSource(ctx context.Context, request CreateNetworkSourceRequest) (response CreateNetworkSourceResponse, err error)

CreateNetworkSource Creates a new network source in your tenancy. You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the network source, which must be unique across all network sources in your tenancy, and cannot be changed. You can use this name or the OCID when writing policies that apply to the network source. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm). You must also specify a *description* for the network source (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateNetworkSource. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed IP address specified in your network source. For more information, see Managing Network Sources (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateNetworkSource.go.html to see an example of how to use CreateNetworkSource API. A default retry strategy applies to this operation CreateNetworkSource()

func (IdentityClient) CreateOAuthClientCredential ¶

func (client IdentityClient) CreateOAuthClientCredential(ctx context.Context, request CreateOAuthClientCredentialRequest) (response CreateOAuthClientCredentialResponse, err error)

CreateOAuthClientCredential Creates Oauth token for the user

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateOAuthClientCredential.go.html to see an example of how to use CreateOAuthClientCredential API. A default retry strategy applies to this operation CreateOAuthClientCredential()

func (IdentityClient) CreateOrResetUIPassword ¶

func (client IdentityClient) CreateOrResetUIPassword(ctx context.Context, request CreateOrResetUIPasswordRequest) (response CreateOrResetUIPasswordResponse, err error)

CreateOrResetUIPassword Creates a new Console one-time password for the specified user. For more information about user credentials, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/usercred/usercredentials.htm). Use this operation after creating a new user, or if a user forgets their password. The new one-time password is returned to you in the response, and you must securely deliver it to the user. They'll be prompted to change this password the next time they sign in to the Console. If they don't change it within 7 days, the password will expire and you'll need to create a new one-time password for the user. (For tenancies that support identity domains) Resetting a user's password generates a reset password email with a link that the user must follow to reset their password. If the user does not reset their password before the link expires, you'll need to reset the user's password again. **Note:** The user's Console login is the unique name you specified when you created the user (see CreateUser).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateOrResetUIPassword.go.html to see an example of how to use CreateOrResetUIPassword API. A default retry strategy applies to this operation CreateOrResetUIPassword()

func (IdentityClient) CreatePolicy ¶

func (client IdentityClient) CreatePolicy(ctx context.Context, request CreatePolicyRequest) (response CreatePolicyResponse, err error)

CreatePolicy Creates a new policy in the specified compartment (either the tenancy or another of your compartments). If you're new to policies, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm). You must specify a *name* for the policy, which must be unique across all policies in your tenancy and cannot be changed. You must also specify a *description* for the policy (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdatePolicy. You must specify one or more policy statements in the statements array. For information about writing policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm) and Common Policies (https://docs.cloud.oracle.com/Content/Identity/policiescommon/commonpolicies.htm). After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. New policies take effect typically within 10 seconds.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreatePolicy.go.html to see an example of how to use CreatePolicy API. A default retry strategy applies to this operation CreatePolicy()

func (IdentityClient) CreateRegionSubscription ¶

func (client IdentityClient) CreateRegionSubscription(ctx context.Context, request CreateRegionSubscriptionRequest) (response CreateRegionSubscriptionResponse, err error)

CreateRegionSubscription Creates a subscription to a region for a tenancy.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateRegionSubscription.go.html to see an example of how to use CreateRegionSubscription API. A default retry strategy applies to this operation CreateRegionSubscription()

func (IdentityClient) CreateSmtpCredential ¶

func (client IdentityClient) CreateSmtpCredential(ctx context.Context, request CreateSmtpCredentialRequest) (response CreateSmtpCredentialResponse, err error)

CreateSmtpCredential Creates a new SMTP credential for the specified user. An SMTP credential has an SMTP user name and an SMTP password. You must specify a *description* for the SMTP credential (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateSmtpCredential.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateSmtpCredential.go.html to see an example of how to use CreateSmtpCredential API. A default retry strategy applies to this operation CreateSmtpCredential()

func (IdentityClient) CreateSwiftPassword ¶

func (client IdentityClient) CreateSwiftPassword(ctx context.Context, request CreateSwiftPasswordRequest) (response CreateSwiftPasswordResponse, err error)

CreateSwiftPassword **Deprecated. Use CreateAuthToken instead.** Creates a new Swift password for the specified user. For information about what Swift passwords are for, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm). You must specify a *description* for the Swift password (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateSwiftPassword. Every user has permission to create a Swift password for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a Swift password for any user, including themselves.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateSwiftPassword.go.html to see an example of how to use CreateSwiftPassword API. A default retry strategy applies to this operation CreateSwiftPassword()

func (IdentityClient) CreateTag ¶

func (client IdentityClient) CreateTag(ctx context.Context, request CreateTagRequest) (response CreateTagResponse, err error)

CreateTag Creates a new tag in the specified tag namespace. The tag requires either the OCID or the name of the tag namespace that will contain this tag definition. You must specify a *name* for the tag, which must be unique across all tags in the tag namespace and cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters. Names are case insensitive. That means, for example, "myTag" and "mytag" are not allowed in the same namespace. If you specify a name that's already in use in the tag namespace, a 409 error is returned. The tag must have a *description*. It does not have to be unique, and you can change it with UpdateTag. The tag must have a value type, which is specified with a validator. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. Lists are validiated. * If no `validator` is set, the user applying the tag to a resource can type in a static value or leave the tag value empty. * If a `validator` is set, the user applying the tag to a resource must select from a list of values that you supply with EnumTagDefinitionValidator.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTag.go.html to see an example of how to use CreateTag API. A default retry strategy applies to this operation CreateTag()

func (IdentityClient) CreateTagDefault ¶

func (client IdentityClient) CreateTagDefault(ctx context.Context, request CreateTagDefaultRequest) (response CreateTagDefaultResponse, err error)

CreateTagDefault Creates a new tag default in the specified compartment for the specified tag definition. If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. * If the `isRequired` flag is set to "true", the value is set during resource creation. * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTagDefault.go.html to see an example of how to use CreateTagDefault API. A default retry strategy applies to this operation CreateTagDefault()

func (IdentityClient) CreateTagNamespace ¶

func (client IdentityClient) CreateTagNamespace(ctx context.Context, request CreateTagNamespaceRequest) (response CreateTagNamespaceResponse, err error)

CreateTagNamespace Creates a new tag namespace in the specified compartment. You must specify the compartment ID in the request object (remember that the tenancy is simply the root compartment). You must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy and cannot be changed. The name can contain any ASCII character except the space (_) or period (.). Names are case insensitive. That means, for example, "myNamespace" and "mynamespace" are not allowed in the same tenancy. Once you created a namespace, you cannot change the name. If you specify a name that's already in use in the tenancy, a 409 error is returned. You must also specify a *description* for the namespace. It does not have to be unique, and you can change it with UpdateTagNamespace.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTagNamespace.go.html to see an example of how to use CreateTagNamespace API. A default retry strategy applies to this operation CreateTagNamespace()

func (IdentityClient) CreateUser ¶

func (client IdentityClient) CreateUser(ctx context.Context, request CreateUserRequest) (response CreateUserResponse, err error)

CreateUser Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other IAM Service components, see Overview of IAM (https://docs.cloud.oracle.com/Content/Identity/getstarted/identity-domains.htm). You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the user, which must be unique across all users in your tenancy and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, underscores, +, and @. If you specify a name that's already in use, you'll get a 409 error. This name will be the user's login to the Console. You might want to pick a name that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses. If you delete a user and then create a new user with the same name, they'll be considered different users because they have different OCIDs. You must also specify a *description* for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateUser. You can use the field to provide the user's full name, a description, a nickname, or other information to generally identify the user. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. A new user has no permissions until you place the user in one or more groups (see AddUserToGroup). If the user needs to access the Console, you need to provide the user a password (see CreateOrResetUIPassword). If the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a public API signing key for that user (see Required Keys and OCIDs (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm) and also UploadApiKey). **Important:** Make sure to inform the new user which compartment(s) they have access to.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateUser.go.html to see an example of how to use CreateUser API. A default retry strategy applies to this operation CreateUser()

func (IdentityClient) DeactivateDomain ¶

func (client IdentityClient) DeactivateDomain(ctx context.Context, request DeactivateDomainRequest) (response DeactivateDomainResponse, err error)

DeactivateDomain (For tenancies that support identity domains) Deactivates the specified identity domain. Identity domains must be in an ACTIVE `lifecycleState` and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate the default identity domain. After you send your request, the `lifecycleDetails` of this identity domain is set to DEACTIVATING. When the operation completes, then the `lifecycleDetails` is set to null and the `lifecycleState` is set to INACTIVE. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeactivateDomain.go.html to see an example of how to use DeactivateDomain API. A default retry strategy applies to this operation DeactivateDomain()

func (IdentityClient) DeleteApiKey ¶

func (client IdentityClient) DeleteApiKey(ctx context.Context, request DeleteApiKeyRequest) (response DeleteApiKeyResponse, err error)

DeleteApiKey Deletes the specified API signing key for the specified user. Every user has permission to use this operation to delete a key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to delete a key for any user, including themselves.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteApiKey.go.html to see an example of how to use DeleteApiKey API. A default retry strategy applies to this operation DeleteApiKey()

func (IdentityClient) DeleteAuthToken ¶

func (client IdentityClient) DeleteAuthToken(ctx context.Context, request DeleteAuthTokenRequest) (response DeleteAuthTokenResponse, err error)

DeleteAuthToken Deletes the specified auth token for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteAuthToken.go.html to see an example of how to use DeleteAuthToken API. A default retry strategy applies to this operation DeleteAuthToken()

func (IdentityClient) DeleteCompartment ¶

func (client IdentityClient) DeleteCompartment(ctx context.Context, request DeleteCompartmentRequest) (response DeleteCompartmentResponse, err error)

DeleteCompartment Deletes the specified compartment. The compartment must be empty.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteCompartment.go.html to see an example of how to use DeleteCompartment API. A default retry strategy applies to this operation DeleteCompartment()

func (IdentityClient) DeleteCustomerSecretKey ¶

func (client IdentityClient) DeleteCustomerSecretKey(ctx context.Context, request DeleteCustomerSecretKeyRequest) (response DeleteCustomerSecretKeyResponse, err error)

DeleteCustomerSecretKey Deletes the specified secret key for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteCustomerSecretKey.go.html to see an example of how to use DeleteCustomerSecretKey API. A default retry strategy applies to this operation DeleteCustomerSecretKey()

func (IdentityClient) DeleteDbCredential ¶

func (client IdentityClient) DeleteDbCredential(ctx context.Context, request DeleteDbCredentialRequest) (response DeleteDbCredentialResponse, err error)

DeleteDbCredential Deletes the specified DB credential for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDbCredential.go.html to see an example of how to use DeleteDbCredential API. A default retry strategy applies to this operation DeleteDbCredential()

func (IdentityClient) DeleteDomain ¶

func (client IdentityClient) DeleteDomain(ctx context.Context, request DeleteDomainRequest) (response DeleteDomainResponse, err error)

DeleteDomain (For tenancies that support identity domains) Deletes an identity domain. The identity domain must have no active apps present in the underlying IDCS stripe. You must also deactivate the identity domain, rendering the `lifecycleState` of the identity domain INACTIVE. Furthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting. Lastly, you cannot delete the default identity domain. A tenancy must always have at least the default identity domain.

To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDomain.go.html to see an example of how to use DeleteDomain API. A default retry strategy applies to this operation DeleteDomain()

func (IdentityClient) DeleteDynamicGroup ¶

func (client IdentityClient) DeleteDynamicGroup(ctx context.Context, request DeleteDynamicGroupRequest) (response DeleteDynamicGroupResponse, err error)

DeleteDynamicGroup Deletes the specified dynamic group.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDynamicGroup.go.html to see an example of how to use DeleteDynamicGroup API. A default retry strategy applies to this operation DeleteDynamicGroup()

func (IdentityClient) DeleteGroup ¶

func (client IdentityClient) DeleteGroup(ctx context.Context, request DeleteGroupRequest) (response DeleteGroupResponse, err error)

DeleteGroup Deletes the specified group. The group must be empty.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteGroup.go.html to see an example of how to use DeleteGroup API. A default retry strategy applies to this operation DeleteGroup()

func (IdentityClient) DeleteIdentityProvider ¶

func (client IdentityClient) DeleteIdentityProvider(ctx context.Context, request DeleteIdentityProviderRequest) (response DeleteIdentityProviderResponse, err error)

DeleteIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Deletes the specified identity provider. The identity provider must not have any group mappings (see IdpGroupMapping).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteIdentityProvider.go.html to see an example of how to use DeleteIdentityProvider API. A default retry strategy applies to this operation DeleteIdentityProvider()

func (IdentityClient) DeleteIdpGroupMapping ¶

func (client IdentityClient) DeleteIdpGroupMapping(ctx context.Context, request DeleteIdpGroupMappingRequest) (response DeleteIdpGroupMappingResponse, err error)

DeleteIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Deletes the specified group mapping.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteIdpGroupMapping.go.html to see an example of how to use DeleteIdpGroupMapping API. A default retry strategy applies to this operation DeleteIdpGroupMapping()

func (IdentityClient) DeleteMfaTotpDevice ¶

func (client IdentityClient) DeleteMfaTotpDevice(ctx context.Context, request DeleteMfaTotpDeviceRequest) (response DeleteMfaTotpDeviceResponse, err error)

DeleteMfaTotpDevice Deletes the specified MFA TOTP device for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteMfaTotpDevice.go.html to see an example of how to use DeleteMfaTotpDevice API. A default retry strategy applies to this operation DeleteMfaTotpDevice()

func (IdentityClient) DeleteNetworkSource ¶

func (client IdentityClient) DeleteNetworkSource(ctx context.Context, request DeleteNetworkSourceRequest) (response DeleteNetworkSourceResponse, err error)

DeleteNetworkSource Deletes the specified network source.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteNetworkSource.go.html to see an example of how to use DeleteNetworkSource API. A default retry strategy applies to this operation DeleteNetworkSource()

func (IdentityClient) DeleteOAuthClientCredential ¶

func (client IdentityClient) DeleteOAuthClientCredential(ctx context.Context, request DeleteOAuthClientCredentialRequest) (response DeleteOAuthClientCredentialResponse, err error)

DeleteOAuthClientCredential Delete Oauth token for the user

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteOAuthClientCredential.go.html to see an example of how to use DeleteOAuthClientCredential API. A default retry strategy applies to this operation DeleteOAuthClientCredential()

func (IdentityClient) DeletePolicy ¶

func (client IdentityClient) DeletePolicy(ctx context.Context, request DeletePolicyRequest) (response DeletePolicyResponse, err error)

DeletePolicy Deletes the specified policy. The deletion takes effect typically within 10 seconds.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeletePolicy.go.html to see an example of how to use DeletePolicy API. A default retry strategy applies to this operation DeletePolicy()

func (IdentityClient) DeleteSmtpCredential ¶

func (client IdentityClient) DeleteSmtpCredential(ctx context.Context, request DeleteSmtpCredentialRequest) (response DeleteSmtpCredentialResponse, err error)

DeleteSmtpCredential Deletes the specified SMTP credential for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteSmtpCredential.go.html to see an example of how to use DeleteSmtpCredential API. A default retry strategy applies to this operation DeleteSmtpCredential()

func (IdentityClient) DeleteSwiftPassword ¶

func (client IdentityClient) DeleteSwiftPassword(ctx context.Context, request DeleteSwiftPasswordRequest) (response DeleteSwiftPasswordResponse, err error)

DeleteSwiftPassword **Deprecated. Use DeleteAuthToken instead.** Deletes the specified Swift password for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteSwiftPassword.go.html to see an example of how to use DeleteSwiftPassword API. A default retry strategy applies to this operation DeleteSwiftPassword()

func (IdentityClient) DeleteTag ¶

func (client IdentityClient) DeleteTag(ctx context.Context, request DeleteTagRequest) (response DeleteTagResponse, err error)

DeleteTag Deletes the specified tag definition. This operation triggers a process that removes the tag from all resources in your tenancy. These things happen immediately:

  • If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking tags limit, whether you first disabled it or not.
  • If the tag was used with dynamic groups, none of the rules that contain the tag will be evaluated against the tag.

When you start the delete operation, the state of the tag changes to DELETING and tag removal from resources begins. This can take up to 48 hours depending on the number of resources that were tagged as well as the regions in which those resources reside. When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag changes its state to DELETED, you can use the same tag name again. After you start this operation, you cannot start either the BulkDeleteTags or the CascadeDeleteTagNamespace operation until this process completes. To delete a tag, you must first retire it. Use UpdateTag to retire a tag.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTag.go.html to see an example of how to use DeleteTag API. A default retry strategy applies to this operation DeleteTag()

func (IdentityClient) DeleteTagDefault ¶

func (client IdentityClient) DeleteTagDefault(ctx context.Context, request DeleteTagDefaultRequest) (response DeleteTagDefaultResponse, err error)

DeleteTagDefault Deletes the the specified tag default.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTagDefault.go.html to see an example of how to use DeleteTagDefault API. A default retry strategy applies to this operation DeleteTagDefault()

func (IdentityClient) DeleteTagNamespace ¶

func (client IdentityClient) DeleteTagNamespace(ctx context.Context, request DeleteTagNamespaceRequest) (response DeleteTagNamespaceResponse, err error)

DeleteTagNamespace Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation to delete a tag namespace that contains tag definitions, first delete all of its tag definitions. Use CascadeDeleteTagNamespace to delete a tag namespace along with all of the tag definitions contained within that namespace. Use DeleteTag to delete a tag definition.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTagNamespace.go.html to see an example of how to use DeleteTagNamespace API. A default retry strategy applies to this operation DeleteTagNamespace()

func (IdentityClient) DeleteUser ¶

func (client IdentityClient) DeleteUser(ctx context.Context, request DeleteUserRequest) (response DeleteUserResponse, err error)

DeleteUser Deletes the specified user. The user must not be in any groups.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteUser.go.html to see an example of how to use DeleteUser API. A default retry strategy applies to this operation DeleteUser()

func (IdentityClient) EnableReplicationToRegion ¶

func (client IdentityClient) EnableReplicationToRegion(ctx context.Context, request EnableReplicationToRegionRequest) (response EnableReplicationToRegionResponse, err error)

EnableReplicationToRegion (For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the tenancy home region or other region that the tenancy subscribes to). You can only replicate identity domains that are in an ACTIVE `lifecycleState` and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains. The default identity domain is automatically replicated to all regions that the tenancy subscribes to. After you send the request, the `state` of the identity domain in the replica region is set to ENABLING_REPLICATION. When the operation completes, the `state` is set to REPLICATION_ENABLED. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/EnableReplicationToRegion.go.html to see an example of how to use EnableReplicationToRegion API. A default retry strategy applies to this operation EnableReplicationToRegion()

func (IdentityClient) GenerateTotpSeed ¶

func (client IdentityClient) GenerateTotpSeed(ctx context.Context, request GenerateTotpSeedRequest) (response GenerateTotpSeedResponse, err error)

GenerateTotpSeed Generate seed for the MFA TOTP device.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GenerateTotpSeed.go.html to see an example of how to use GenerateTotpSeed API. A default retry strategy applies to this operation GenerateTotpSeed()

func (IdentityClient) GetAuthenticationPolicy ¶

func (client IdentityClient) GetAuthenticationPolicy(ctx context.Context, request GetAuthenticationPolicyRequest) (response GetAuthenticationPolicyResponse, err error)

GetAuthenticationPolicy Gets the authentication policy for the given tenancy. You must specify your tenant's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetAuthenticationPolicy.go.html to see an example of how to use GetAuthenticationPolicy API. A default retry strategy applies to this operation GetAuthenticationPolicy()

func (IdentityClient) GetCompartment ¶

func (client IdentityClient) GetCompartment(ctx context.Context, request GetCompartmentRequest) (response GetCompartmentResponse, err error)

GetCompartment Gets the specified compartment's information. This operation does not return a list of all the resources inside the compartment. There is no single API operation that does that. Compartments can contain multiple types of resources (instances, block storage volumes, etc.). To find out what's in a compartment, you must call the "List" operation for each resource type and specify the compartment's OCID as a query parameter in the request. For example, call the ListInstances operation in the Cloud Compute Service or the ListVolumes operation in Cloud Block Storage.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetCompartment.go.html to see an example of how to use GetCompartment API. A default retry strategy applies to this operation GetCompartment()

func (IdentityClient) GetDomain ¶

func (client IdentityClient) GetDomain(ctx context.Context, request GetDomainRequest) (response GetDomainResponse, err error)

GetDomain (For tenancies that support identity domains) Gets the specified identity domain's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetDomain.go.html to see an example of how to use GetDomain API. A default retry strategy applies to this operation GetDomain()

func (IdentityClient) GetDynamicGroup ¶

func (client IdentityClient) GetDynamicGroup(ctx context.Context, request GetDynamicGroupRequest) (response GetDynamicGroupResponse, err error)

GetDynamicGroup Gets the specified dynamic group's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetDynamicGroup.go.html to see an example of how to use GetDynamicGroup API. A default retry strategy applies to this operation GetDynamicGroup()

func (IdentityClient) GetGroup ¶

func (client IdentityClient) GetGroup(ctx context.Context, request GetGroupRequest) (response GetGroupResponse, err error)

GetGroup Gets the specified group's information. This operation does not return a list of all the users in the group. To do that, use ListUserGroupMemberships and provide the group's OCID as a query parameter in the request.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetGroup.go.html to see an example of how to use GetGroup API. A default retry strategy applies to this operation GetGroup()

func (IdentityClient) GetIamWorkRequest ¶

func (client IdentityClient) GetIamWorkRequest(ctx context.Context, request GetIamWorkRequestRequest) (response GetIamWorkRequestResponse, err error)

GetIamWorkRequest Gets the details of a specified IAM work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIamWorkRequest.go.html to see an example of how to use GetIamWorkRequest API. A default retry strategy applies to this operation GetIamWorkRequest()

func (IdentityClient) GetIdentityProvider ¶

func (client IdentityClient) GetIdentityProvider(ctx context.Context, request GetIdentityProviderRequest) (response GetIdentityProviderResponse, err error)

GetIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Gets the specified identity provider's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIdentityProvider.go.html to see an example of how to use GetIdentityProvider API. A default retry strategy applies to this operation GetIdentityProvider()

func (IdentityClient) GetIdpGroupMapping ¶

func (client IdentityClient) GetIdpGroupMapping(ctx context.Context, request GetIdpGroupMappingRequest) (response GetIdpGroupMappingResponse, err error)

GetIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Gets the specified group mapping.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIdpGroupMapping.go.html to see an example of how to use GetIdpGroupMapping API. A default retry strategy applies to this operation GetIdpGroupMapping()

func (IdentityClient) GetMfaTotpDevice ¶

func (client IdentityClient) GetMfaTotpDevice(ctx context.Context, request GetMfaTotpDeviceRequest) (response GetMfaTotpDeviceResponse, err error)

GetMfaTotpDevice Get the specified MFA TOTP device for the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetMfaTotpDevice.go.html to see an example of how to use GetMfaTotpDevice API. A default retry strategy applies to this operation GetMfaTotpDevice()

func (IdentityClient) GetNetworkSource ¶

func (client IdentityClient) GetNetworkSource(ctx context.Context, request GetNetworkSourceRequest) (response GetNetworkSourceResponse, err error)

GetNetworkSource Gets the specified network source's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetNetworkSource.go.html to see an example of how to use GetNetworkSource API. A default retry strategy applies to this operation GetNetworkSource()

func (IdentityClient) GetPolicy ¶

func (client IdentityClient) GetPolicy(ctx context.Context, request GetPolicyRequest) (response GetPolicyResponse, err error)

GetPolicy Gets the specified policy's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetPolicy.go.html to see an example of how to use GetPolicy API. A default retry strategy applies to this operation GetPolicy()

func (IdentityClient) GetStandardTagTemplate ¶

func (client IdentityClient) GetStandardTagTemplate(ctx context.Context, request GetStandardTagTemplateRequest) (response GetStandardTagTemplateResponse, err error)

GetStandardTagTemplate Retrieve the standard tag namespace template given the standard tag namespace name.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetStandardTagTemplate.go.html to see an example of how to use GetStandardTagTemplate API. A default retry strategy applies to this operation GetStandardTagTemplate()

func (IdentityClient) GetTag ¶

func (client IdentityClient) GetTag(ctx context.Context, request GetTagRequest) (response GetTagResponse, err error)

GetTag Gets the specified tag's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTag.go.html to see an example of how to use GetTag API. A default retry strategy applies to this operation GetTag()

func (IdentityClient) GetTagDefault ¶

func (client IdentityClient) GetTagDefault(ctx context.Context, request GetTagDefaultRequest) (response GetTagDefaultResponse, err error)

GetTagDefault Retrieves the specified tag default.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTagDefault.go.html to see an example of how to use GetTagDefault API. A default retry strategy applies to this operation GetTagDefault()

func (IdentityClient) GetTagNamespace ¶

func (client IdentityClient) GetTagNamespace(ctx context.Context, request GetTagNamespaceRequest) (response GetTagNamespaceResponse, err error)

GetTagNamespace Gets the specified tag namespace's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTagNamespace.go.html to see an example of how to use GetTagNamespace API. A default retry strategy applies to this operation GetTagNamespace()

func (IdentityClient) GetTaggingWorkRequest ¶

func (client IdentityClient) GetTaggingWorkRequest(ctx context.Context, request GetTaggingWorkRequestRequest) (response GetTaggingWorkRequestResponse, err error)

GetTaggingWorkRequest Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in tagging service.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTaggingWorkRequest.go.html to see an example of how to use GetTaggingWorkRequest API. A default retry strategy applies to this operation GetTaggingWorkRequest()

func (IdentityClient) GetTenancy ¶

func (client IdentityClient) GetTenancy(ctx context.Context, request GetTenancyRequest) (response GetTenancyResponse, err error)

GetTenancy Get the specified tenancy's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTenancy.go.html to see an example of how to use GetTenancy API. A default retry strategy applies to this operation GetTenancy()

func (IdentityClient) GetUser ¶

func (client IdentityClient) GetUser(ctx context.Context, request GetUserRequest) (response GetUserResponse, err error)

GetUser Gets the specified user's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUser.go.html to see an example of how to use GetUser API. A default retry strategy applies to this operation GetUser()

func (IdentityClient) GetUserGroupMembership ¶

func (client IdentityClient) GetUserGroupMembership(ctx context.Context, request GetUserGroupMembershipRequest) (response GetUserGroupMembershipResponse, err error)

GetUserGroupMembership Gets the specified UserGroupMembership's information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUserGroupMembership.go.html to see an example of how to use GetUserGroupMembership API. A default retry strategy applies to this operation GetUserGroupMembership()

func (IdentityClient) GetUserUIPasswordInformation ¶

func (client IdentityClient) GetUserUIPasswordInformation(ctx context.Context, request GetUserUIPasswordInformationRequest) (response GetUserUIPasswordInformationResponse, err error)

GetUserUIPasswordInformation Gets the specified user's console password information. The returned object contains the user's OCID, but not the password itself. The actual password is returned only when created or reset.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUserUIPasswordInformation.go.html to see an example of how to use GetUserUIPasswordInformation API. A default retry strategy applies to this operation GetUserUIPasswordInformation()

func (IdentityClient) GetWorkRequest ¶

func (client IdentityClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the compartment service.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (IdentityClient) ImportStandardTags ¶

func (client IdentityClient) ImportStandardTags(ctx context.Context, request ImportStandardTagsRequest) (response ImportStandardTagsResponse, err error)

ImportStandardTags OCI will release Tag Namespaces that our customers can import. These Tag Namespaces will provide Tags for our customers and Partners to provide consistency and enable data reporting.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ImportStandardTags.go.html to see an example of how to use ImportStandardTags API. A default retry strategy applies to this operation ImportStandardTags()

func (IdentityClient) ListAllowedDomainLicenseTypes ¶

func (client IdentityClient) ListAllowedDomainLicenseTypes(ctx context.Context, request ListAllowedDomainLicenseTypesRequest) (response ListAllowedDomainLicenseTypesResponse, err error)

ListAllowedDomainLicenseTypes (For tenancies that support identity domains) Lists the license types for identity domains supported by Oracle Cloud Infrastructure. (License types are also referred to as domain types.) If `currentLicenseTypeName` is provided, then the request returns license types that the identity domain with the specified license type name can change to. Otherwise, the request returns all valid license types currently supported.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAllowedDomainLicenseTypes.go.html to see an example of how to use ListAllowedDomainLicenseTypes API. A default retry strategy applies to this operation ListAllowedDomainLicenseTypes()

func (IdentityClient) ListApiKeys ¶

func (client IdentityClient) ListApiKeys(ctx context.Context, request ListApiKeysRequest) (response ListApiKeysResponse, err error)

ListApiKeys Lists the API signing keys for the specified user. A user can have a maximum of three keys. Every user has permission to use this API call for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListApiKeys.go.html to see an example of how to use ListApiKeys API. A default retry strategy applies to this operation ListApiKeys()

func (IdentityClient) ListAuthTokens ¶

func (client IdentityClient) ListAuthTokens(ctx context.Context, request ListAuthTokensRequest) (response ListAuthTokensResponse, err error)

ListAuthTokens Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not the token itself. The actual token is returned only upon creation.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAuthTokens.go.html to see an example of how to use ListAuthTokens API. A default retry strategy applies to this operation ListAuthTokens()

func (IdentityClient) ListAvailabilityDomains ¶

func (client IdentityClient) ListAvailabilityDomains(ctx context.Context, request ListAvailabilityDomainsRequest) (response ListAvailabilityDomainsResponse, err error)

ListAvailabilityDomains Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five). Note that the order of the results returned can change if availability domains are added or removed; therefore, do not create a dependency on the list order.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAvailabilityDomains.go.html to see an example of how to use ListAvailabilityDomains API. A default retry strategy applies to this operation ListAvailabilityDomains()

func (IdentityClient) ListBulkActionResourceTypes ¶

func (client IdentityClient) ListBulkActionResourceTypes(ctx context.Context, request ListBulkActionResourceTypesRequest) (response ListBulkActionResourceTypesResponse, err error)

ListBulkActionResourceTypes Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct resource-type information to the BulkDeleteResources and BulkMoveResources operations. The returned list of resource-types provides the appropriate resource-type names to use with the bulk action operations along with the type of identifying information you'll need to provide for each resource-type. Most resource-types just require an OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types, such as buckets, require you to provide other identifying information.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListBulkActionResourceTypes.go.html to see an example of how to use ListBulkActionResourceTypes API. A default retry strategy applies to this operation ListBulkActionResourceTypes()

func (IdentityClient) ListBulkEditTagsResourceTypes ¶

func (client IdentityClient) ListBulkEditTagsResourceTypes(ctx context.Context, request ListBulkEditTagsResourceTypesRequest) (response ListBulkEditTagsResourceTypesResponse, err error)

ListBulkEditTagsResourceTypes Lists the resource types that support bulk tag editing.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListBulkEditTagsResourceTypes.go.html to see an example of how to use ListBulkEditTagsResourceTypes API. A default retry strategy applies to this operation ListBulkEditTagsResourceTypes()

func (IdentityClient) ListCompartments ¶

func (client IdentityClient) ListCompartments(ctx context.Context, request ListCompartmentsRequest) (response ListCompartmentsResponse, err error)

ListCompartments Lists the compartments in a specified compartment. The members of the list returned depends on the values set for several parameters. With the exception of the tenancy (root compartment), the ListCompartments operation returns only the first-level child compartments in the parent compartment specified in `compartmentId`. The list does not include any subcompartments of the child compartments (grandchildren). The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (the resource can be in a subcompartment). The parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the tenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY. See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCompartments.go.html to see an example of how to use ListCompartments API. A default retry strategy applies to this operation ListCompartments()

func (IdentityClient) ListCostTrackingTags ¶

func (client IdentityClient) ListCostTrackingTags(ctx context.Context, request ListCostTrackingTagsRequest) (response ListCostTrackingTagsResponse, err error)

ListCostTrackingTags Lists all the tags enabled for cost-tracking in the specified tenancy. For information about cost-tracking tags, see Using Cost-tracking Tags (https://docs.cloud.oracle.com/Content/Tagging/Tasks/usingcosttrackingtags.htm).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCostTrackingTags.go.html to see an example of how to use ListCostTrackingTags API. A default retry strategy applies to this operation ListCostTrackingTags()

func (IdentityClient) ListCustomerSecretKeys ¶

func (client IdentityClient) ListCustomerSecretKeys(ctx context.Context, request ListCustomerSecretKeysRequest) (response ListCustomerSecretKeysResponse, err error)

ListCustomerSecretKeys Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not the secret key itself. The actual secret key is returned only upon creation.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCustomerSecretKeys.go.html to see an example of how to use ListCustomerSecretKeys API. A default retry strategy applies to this operation ListCustomerSecretKeys()

func (IdentityClient) ListDbCredentials ¶

func (client IdentityClient) ListDbCredentials(ctx context.Context, request ListDbCredentialsRequest) (response ListDbCredentialsResponse, err error)

ListDbCredentials Lists the DB credentials for the specified user. The returned object contains the credential's OCID

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDbCredentials.go.html to see an example of how to use ListDbCredentials API. A default retry strategy applies to this operation ListDbCredentials()

func (IdentityClient) ListDomains ¶

func (client IdentityClient) ListDomains(ctx context.Context, request ListDomainsRequest) (response ListDomainsResponse, err error)

ListDomains (For tenancies that support identity domains) Lists all identity domains within a tenancy.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDomains.go.html to see an example of how to use ListDomains API. A default retry strategy applies to this operation ListDomains()

func (IdentityClient) ListDynamicGroups ¶

func (client IdentityClient) ListDynamicGroups(ctx context.Context, request ListDynamicGroupsRequest) (response ListDynamicGroupsResponse, err error)

ListDynamicGroups Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDynamicGroups.go.html to see an example of how to use ListDynamicGroups API. A default retry strategy applies to this operation ListDynamicGroups()

func (IdentityClient) ListFaultDomains ¶

func (client IdentityClient) ListFaultDomains(ctx context.Context, request ListFaultDomainsRequest) (response ListFaultDomainsResponse, err error)

ListFaultDomains Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListFaultDomains.go.html to see an example of how to use ListFaultDomains API. A default retry strategy applies to this operation ListFaultDomains()

func (IdentityClient) ListGroups ¶

func (client IdentityClient) ListGroups(ctx context.Context, request ListGroupsRequest) (response ListGroupsResponse, err error)

ListGroups Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListGroups.go.html to see an example of how to use ListGroups API. A default retry strategy applies to this operation ListGroups()

func (IdentityClient) ListIamWorkRequestErrors ¶

func (client IdentityClient) ListIamWorkRequestErrors(ctx context.Context, request ListIamWorkRequestErrorsRequest) (response ListIamWorkRequestErrorsResponse, err error)

ListIamWorkRequestErrors Gets error details for a specified IAM work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequestErrors.go.html to see an example of how to use ListIamWorkRequestErrors API. A default retry strategy applies to this operation ListIamWorkRequestErrors()

func (IdentityClient) ListIamWorkRequestLogs ¶

func (client IdentityClient) ListIamWorkRequestLogs(ctx context.Context, request ListIamWorkRequestLogsRequest) (response ListIamWorkRequestLogsResponse, err error)

ListIamWorkRequestLogs Gets logs for a specified IAM work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequestLogs.go.html to see an example of how to use ListIamWorkRequestLogs API. A default retry strategy applies to this operation ListIamWorkRequestLogs()

func (IdentityClient) ListIamWorkRequests ¶

func (client IdentityClient) ListIamWorkRequests(ctx context.Context, request ListIamWorkRequestsRequest) (response ListIamWorkRequestsResponse, err error)

ListIamWorkRequests Lists the IAM work requests in compartment. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequests.go.html to see an example of how to use ListIamWorkRequests API. A default retry strategy applies to this operation ListIamWorkRequests()

func (IdentityClient) ListIdentityProviderGroups ¶

func (client IdentityClient) ListIdentityProviderGroups(ctx context.Context, request ListIdentityProviderGroupsRequest) (response ListIdentityProviderGroupsResponse, err error)

ListIdentityProviderGroups **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Lists the identity provider groups.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdentityProviderGroups.go.html to see an example of how to use ListIdentityProviderGroups API. A default retry strategy applies to this operation ListIdentityProviderGroups()

func (IdentityClient) ListIdentityProviders ¶

func (client IdentityClient) ListIdentityProviders(ctx context.Context, request ListIdentityProvidersRequest) (response ListIdentityProvidersResponse, err error)

ListIdentityProviders **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdentityProviders.go.html to see an example of how to use ListIdentityProviders API. A default retry strategy applies to this operation ListIdentityProviders()

func (IdentityClient) ListIdpGroupMappings ¶

func (client IdentityClient) ListIdpGroupMappings(ctx context.Context, request ListIdpGroupMappingsRequest) (response ListIdpGroupMappingsResponse, err error)

ListIdpGroupMappings **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Lists the group mappings for the specified identity provider.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdpGroupMappings.go.html to see an example of how to use ListIdpGroupMappings API. A default retry strategy applies to this operation ListIdpGroupMappings()

func (IdentityClient) ListMfaTotpDevices ¶

func (client IdentityClient) ListMfaTotpDevices(ctx context.Context, request ListMfaTotpDevicesRequest) (response ListMfaTotpDevicesResponse, err error)

ListMfaTotpDevices Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListMfaTotpDevices.go.html to see an example of how to use ListMfaTotpDevices API. A default retry strategy applies to this operation ListMfaTotpDevices()

func (IdentityClient) ListNetworkSources ¶

func (client IdentityClient) ListNetworkSources(ctx context.Context, request ListNetworkSourcesRequest) (response ListNetworkSourcesResponse, err error)

ListNetworkSources Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListNetworkSources.go.html to see an example of how to use ListNetworkSources API. A default retry strategy applies to this operation ListNetworkSources()

func (IdentityClient) ListOAuthClientCredentials ¶

func (client IdentityClient) ListOAuthClientCredentials(ctx context.Context, request ListOAuthClientCredentialsRequest) (response ListOAuthClientCredentialsResponse, err error)

ListOAuthClientCredentials List of Oauth tokens for the user

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListOAuthClientCredentials.go.html to see an example of how to use ListOAuthClientCredentials API. A default retry strategy applies to this operation ListOAuthClientCredentials()

func (IdentityClient) ListPolicies ¶

func (client IdentityClient) ListPolicies(ctx context.Context, request ListPoliciesRequest) (response ListPoliciesResponse, err error)

ListPolicies Lists the policies in the specified compartment (either the tenancy or another of your compartments). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five). To determine which policies apply to a particular group or compartment, you must view the individual statements inside all your policies. There isn't a way to automatically obtain that information via the API.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListPolicies.go.html to see an example of how to use ListPolicies API. A default retry strategy applies to this operation ListPolicies()

func (IdentityClient) ListRegionSubscriptions ¶

func (client IdentityClient) ListRegionSubscriptions(ctx context.Context, request ListRegionSubscriptionsRequest) (response ListRegionSubscriptionsResponse, err error)

ListRegionSubscriptions Lists the region subscriptions for the specified tenancy.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListRegionSubscriptions.go.html to see an example of how to use ListRegionSubscriptions API. A default retry strategy applies to this operation ListRegionSubscriptions()

func (IdentityClient) ListRegions ¶

func (client IdentityClient) ListRegions(ctx context.Context) (response ListRegionsResponse, err error)

ListRegions Lists all the regions offered by Oracle Cloud Infrastructure.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListRegions.go.html to see an example of how to use ListRegions API. A default retry strategy applies to this operation ListRegions()

func (IdentityClient) ListSmtpCredentials ¶

func (client IdentityClient) ListSmtpCredentials(ctx context.Context, request ListSmtpCredentialsRequest) (response ListSmtpCredentialsResponse, err error)

ListSmtpCredentials Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID, the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListSmtpCredentials.go.html to see an example of how to use ListSmtpCredentials API. A default retry strategy applies to this operation ListSmtpCredentials()

func (IdentityClient) ListStandardTagNamespaces ¶

func (client IdentityClient) ListStandardTagNamespaces(ctx context.Context, request ListStandardTagNamespacesRequest) (response ListStandardTagNamespacesResponse, err error)

ListStandardTagNamespaces Lists available standard tag namespaces that users can create.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListStandardTagNamespaces.go.html to see an example of how to use ListStandardTagNamespaces API. A default retry strategy applies to this operation ListStandardTagNamespaces()

func (IdentityClient) ListSwiftPasswords ¶

func (client IdentityClient) ListSwiftPasswords(ctx context.Context, request ListSwiftPasswordsRequest) (response ListSwiftPasswordsResponse, err error)

ListSwiftPasswords **Deprecated. Use ListAuthTokens instead.** Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not the password itself. The actual password is returned only upon creation.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListSwiftPasswords.go.html to see an example of how to use ListSwiftPasswords API. A default retry strategy applies to this operation ListSwiftPasswords()

func (IdentityClient) ListTagDefaults ¶

func (client IdentityClient) ListTagDefaults(ctx context.Context, request ListTagDefaultsRequest) (response ListTagDefaultsResponse, err error)

ListTagDefaults Lists the tag defaults for tag definitions in the specified compartment.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTagDefaults.go.html to see an example of how to use ListTagDefaults API. A default retry strategy applies to this operation ListTagDefaults()

func (IdentityClient) ListTagNamespaces ¶

func (client IdentityClient) ListTagNamespaces(ctx context.Context, request ListTagNamespacesRequest) (response ListTagNamespacesResponse, err error)

ListTagNamespaces Lists the tag namespaces in the specified compartment.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTagNamespaces.go.html to see an example of how to use ListTagNamespaces API. A default retry strategy applies to this operation ListTagNamespaces()

func (IdentityClient) ListTaggingWorkRequestErrors ¶

func (client IdentityClient) ListTaggingWorkRequestErrors(ctx context.Context, request ListTaggingWorkRequestErrorsRequest) (response ListTaggingWorkRequestErrorsResponse, err error)

ListTaggingWorkRequestErrors Gets the errors for a work request.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequestErrors.go.html to see an example of how to use ListTaggingWorkRequestErrors API. A default retry strategy applies to this operation ListTaggingWorkRequestErrors()

func (IdentityClient) ListTaggingWorkRequestLogs ¶

func (client IdentityClient) ListTaggingWorkRequestLogs(ctx context.Context, request ListTaggingWorkRequestLogsRequest) (response ListTaggingWorkRequestLogsResponse, err error)

ListTaggingWorkRequestLogs Gets the logs for a work request.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequestLogs.go.html to see an example of how to use ListTaggingWorkRequestLogs API. A default retry strategy applies to this operation ListTaggingWorkRequestLogs()

func (IdentityClient) ListTaggingWorkRequests ¶

func (client IdentityClient) ListTaggingWorkRequests(ctx context.Context, request ListTaggingWorkRequestsRequest) (response ListTaggingWorkRequestsResponse, err error)

ListTaggingWorkRequests Lists the tagging work requests in compartment.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequests.go.html to see an example of how to use ListTaggingWorkRequests API. A default retry strategy applies to this operation ListTaggingWorkRequests()

func (IdentityClient) ListTags ¶

func (client IdentityClient) ListTags(ctx context.Context, request ListTagsRequest) (response ListTagsResponse, err error)

ListTags Lists the tag definitions in the specified tag namespace.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTags.go.html to see an example of how to use ListTags API. A default retry strategy applies to this operation ListTags()

func (IdentityClient) ListUserGroupMemberships ¶

func (client IdentityClient) ListUserGroupMemberships(ctx context.Context, request ListUserGroupMembershipsRequest) (response ListUserGroupMembershipsResponse, err error)

ListUserGroupMemberships Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (see Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five)). You must also then filter the list in one of these ways: - You can limit the results to just the memberships for a given user by specifying a `userId`. - Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`. - You can set both the `userId` and `groupId` to determine if the specified user is in the specified group. If the answer is no, the response is an empty list. - Although`userId` and `groupId` are not individually required, you must set one of them.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListUserGroupMemberships.go.html to see an example of how to use ListUserGroupMemberships API. A default retry strategy applies to this operation ListUserGroupMemberships()

func (IdentityClient) ListUsers ¶

func (client IdentityClient) ListUsers(ctx context.Context, request ListUsersRequest) (response ListUsersResponse, err error)

ListUsers Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListUsers.go.html to see an example of how to use ListUsers API. A default retry strategy applies to this operation ListUsers()

func (IdentityClient) ListWorkRequests ¶

func (client IdentityClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in compartment.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (IdentityClient) MoveCompartment ¶

func (client IdentityClient) MoveCompartment(ctx context.Context, request MoveCompartmentRequest) (response MoveCompartmentResponse, err error)

MoveCompartment Move the compartment to a different parent compartment in the same tenancy. When you move a compartment, all its contents (subcompartments and resources) are moved with it. Note that the `CompartmentId` that you specify in the path is the compartment that you want to move. **IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of the new parent take effect and the policies of the previous parent no longer apply. Ensure that you are aware of the implications for the compartment contents before you move it. For more information, see Moving a Compartment (https://docs.cloud.oracle.com/Content/Identity/compartments/managingcompartments.htm#MoveCompartment).

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/MoveCompartment.go.html to see an example of how to use MoveCompartment API. A default retry strategy applies to this operation MoveCompartment()

func (IdentityClient) RecoverCompartment ¶

func (client IdentityClient) RecoverCompartment(ctx context.Context, request RecoverCompartmentRequest) (response RecoverCompartmentResponse, err error)

RecoverCompartment Recover the compartment from DELETED state to ACTIVE state.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RecoverCompartment.go.html to see an example of how to use RecoverCompartment API. A default retry strategy applies to this operation RecoverCompartment()

func (IdentityClient) RemoveTagDefaultLock ¶ added in v65.9.0

func (client IdentityClient) RemoveTagDefaultLock(ctx context.Context, request RemoveTagDefaultLockRequest) (response RemoveTagDefaultLockResponse, err error)

RemoveTagDefaultLock Remove a resource lock from a tag default.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveTagDefaultLock.go.html to see an example of how to use RemoveTagDefaultLock API. A default retry strategy applies to this operation RemoveTagDefaultLock()

func (IdentityClient) RemoveTagNamespaceLock ¶ added in v65.9.0

func (client IdentityClient) RemoveTagNamespaceLock(ctx context.Context, request RemoveTagNamespaceLockRequest) (response RemoveTagNamespaceLockResponse, err error)

RemoveTagNamespaceLock Remove a resource lock from a tag namespace.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveTagNamespaceLock.go.html to see an example of how to use RemoveTagNamespaceLock API. A default retry strategy applies to this operation RemoveTagNamespaceLock()

func (IdentityClient) RemoveUserFromGroup ¶

func (client IdentityClient) RemoveUserFromGroup(ctx context.Context, request RemoveUserFromGroupRequest) (response RemoveUserFromGroupResponse, err error)

RemoveUserFromGroup Removes a user from a group by deleting the corresponding `UserGroupMembership`.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveUserFromGroup.go.html to see an example of how to use RemoveUserFromGroup API. A default retry strategy applies to this operation RemoveUserFromGroup()

func (IdentityClient) ResetIdpScimClient ¶

func (client IdentityClient) ResetIdpScimClient(ctx context.Context, request ResetIdpScimClientRequest) (response ResetIdpScimClientResponse, err error)

ResetIdpScimClient Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ResetIdpScimClient.go.html to see an example of how to use ResetIdpScimClient API. A default retry strategy applies to this operation ResetIdpScimClient()

func (*IdentityClient) SetRegion ¶

func (client *IdentityClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (IdentityClient) UpdateAuthToken ¶

func (client IdentityClient) UpdateAuthToken(ctx context.Context, request UpdateAuthTokenRequest) (response UpdateAuthTokenResponse, err error)

UpdateAuthToken Updates the specified auth token's description.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateAuthToken.go.html to see an example of how to use UpdateAuthToken API. A default retry strategy applies to this operation UpdateAuthToken()

func (IdentityClient) UpdateAuthenticationPolicy ¶

func (client IdentityClient) UpdateAuthenticationPolicy(ctx context.Context, request UpdateAuthenticationPolicyRequest) (response UpdateAuthenticationPolicyResponse, err error)

UpdateAuthenticationPolicy Updates authentication policy for the specified tenancy.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateAuthenticationPolicy.go.html to see an example of how to use UpdateAuthenticationPolicy API. A default retry strategy applies to this operation UpdateAuthenticationPolicy()

func (IdentityClient) UpdateCompartment ¶

func (client IdentityClient) UpdateCompartment(ctx context.Context, request UpdateCompartmentRequest) (response UpdateCompartmentResponse, err error)

UpdateCompartment Updates the specified compartment's description or name. You can't update the root compartment.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateCompartment.go.html to see an example of how to use UpdateCompartment API. A default retry strategy applies to this operation UpdateCompartment()

func (IdentityClient) UpdateCustomerSecretKey ¶

func (client IdentityClient) UpdateCustomerSecretKey(ctx context.Context, request UpdateCustomerSecretKeyRequest) (response UpdateCustomerSecretKeyResponse, err error)

UpdateCustomerSecretKey Updates the specified secret key's description.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateCustomerSecretKey.go.html to see an example of how to use UpdateCustomerSecretKey API. A default retry strategy applies to this operation UpdateCustomerSecretKey()

func (IdentityClient) UpdateDomain ¶

func (client IdentityClient) UpdateDomain(ctx context.Context, request UpdateDomainRequest) (response UpdateDomainResponse, err error)

UpdateDomain (For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe. To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves the operation's status.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateDomain.go.html to see an example of how to use UpdateDomain API. A default retry strategy applies to this operation UpdateDomain()

func (IdentityClient) UpdateDynamicGroup ¶

func (client IdentityClient) UpdateDynamicGroup(ctx context.Context, request UpdateDynamicGroupRequest) (response UpdateDynamicGroupResponse, err error)

UpdateDynamicGroup Updates the specified dynamic group.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateDynamicGroup.go.html to see an example of how to use UpdateDynamicGroup API. A default retry strategy applies to this operation UpdateDynamicGroup()

func (IdentityClient) UpdateGroup ¶

func (client IdentityClient) UpdateGroup(ctx context.Context, request UpdateGroupRequest) (response UpdateGroupResponse, err error)

UpdateGroup Updates the specified group.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateGroup.go.html to see an example of how to use UpdateGroup API. A default retry strategy applies to this operation UpdateGroup()

func (IdentityClient) UpdateIdentityProvider ¶

func (client IdentityClient) UpdateIdentityProvider(ctx context.Context, request UpdateIdentityProviderRequest) (response UpdateIdentityProviderResponse, err error)

UpdateIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Updates the specified identity provider.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateIdentityProvider.go.html to see an example of how to use UpdateIdentityProvider API. A default retry strategy applies to this operation UpdateIdentityProvider()

func (IdentityClient) UpdateIdpGroupMapping ¶

func (client IdentityClient) UpdateIdpGroupMapping(ctx context.Context, request UpdateIdpGroupMappingRequest) (response UpdateIdpGroupMappingResponse, err error)

UpdateIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm). Updates the specified group mapping.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateIdpGroupMapping.go.html to see an example of how to use UpdateIdpGroupMapping API. A default retry strategy applies to this operation UpdateIdpGroupMapping()

func (IdentityClient) UpdateNetworkSource ¶

func (client IdentityClient) UpdateNetworkSource(ctx context.Context, request UpdateNetworkSourceRequest) (response UpdateNetworkSourceResponse, err error)

UpdateNetworkSource Updates the specified network source.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateNetworkSource.go.html to see an example of how to use UpdateNetworkSource API. A default retry strategy applies to this operation UpdateNetworkSource()

func (IdentityClient) UpdateOAuthClientCredential ¶

func (client IdentityClient) UpdateOAuthClientCredential(ctx context.Context, request UpdateOAuthClientCredentialRequest) (response UpdateOAuthClientCredentialResponse, err error)

UpdateOAuthClientCredential Updates Oauth token for the user

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateOAuthClientCredential.go.html to see an example of how to use UpdateOAuthClientCredential API. A default retry strategy applies to this operation UpdateOAuthClientCredential()

func (IdentityClient) UpdatePolicy ¶

func (client IdentityClient) UpdatePolicy(ctx context.Context, request UpdatePolicyRequest) (response UpdatePolicyResponse, err error)

UpdatePolicy Updates the specified policy. You can update the description or the policy statements themselves. Policy changes take effect typically within 10 seconds.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdatePolicy.go.html to see an example of how to use UpdatePolicy API. A default retry strategy applies to this operation UpdatePolicy()

func (IdentityClient) UpdateSmtpCredential ¶

func (client IdentityClient) UpdateSmtpCredential(ctx context.Context, request UpdateSmtpCredentialRequest) (response UpdateSmtpCredentialResponse, err error)

UpdateSmtpCredential Updates the specified SMTP credential's description.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateSmtpCredential.go.html to see an example of how to use UpdateSmtpCredential API. A default retry strategy applies to this operation UpdateSmtpCredential()

func (IdentityClient) UpdateSwiftPassword ¶

func (client IdentityClient) UpdateSwiftPassword(ctx context.Context, request UpdateSwiftPasswordRequest) (response UpdateSwiftPasswordResponse, err error)

UpdateSwiftPassword **Deprecated. Use UpdateAuthToken instead.** Updates the specified Swift password's description.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateSwiftPassword.go.html to see an example of how to use UpdateSwiftPassword API. A default retry strategy applies to this operation UpdateSwiftPassword()

func (IdentityClient) UpdateTag ¶

func (client IdentityClient) UpdateTag(ctx context.Context, request UpdateTagRequest) (response UpdateTagResponse, err error)

UpdateTag Updates the specified tag definition. Setting `validator` determines the value type. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. On update, any values in a list that were previously set do not change, but new values must pass validation. Values already applied to a resource do not change. You cannot remove list values that appear in a TagDefault. To remove a list value that appears in a TagDefault, first update the TagDefault to use a different value.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTag.go.html to see an example of how to use UpdateTag API. A default retry strategy applies to this operation UpdateTag()

func (IdentityClient) UpdateTagDefault ¶

func (client IdentityClient) UpdateTagDefault(ctx context.Context, request UpdateTagDefaultRequest) (response UpdateTagDefaultResponse, err error)

UpdateTagDefault Updates the specified tag default. If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. * If the `isRequired` flag is set to "true", the value is set during resource creation. * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTagDefault.go.html to see an example of how to use UpdateTagDefault API. A default retry strategy applies to this operation UpdateTagDefault()

func (IdentityClient) UpdateTagNamespace ¶

func (client IdentityClient) UpdateTagNamespace(ctx context.Context, request UpdateTagNamespaceRequest) (response UpdateTagNamespaceResponse, err error)

UpdateTagNamespace Updates the the specified tag namespace. You can't update the namespace name. Updating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a namespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions. To reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace, using UpdateTag. For more information about retiring tag namespaces, see Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). You can't add a namespace with the same name as a retired namespace in the same tenancy.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTagNamespace.go.html to see an example of how to use UpdateTagNamespace API. A default retry strategy applies to this operation UpdateTagNamespace()

func (IdentityClient) UpdateUser ¶

func (client IdentityClient) UpdateUser(ctx context.Context, request UpdateUserRequest) (response UpdateUserResponse, err error)

UpdateUser Updates the description of the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUser.go.html to see an example of how to use UpdateUser API. A default retry strategy applies to this operation UpdateUser()

func (IdentityClient) UpdateUserCapabilities ¶

func (client IdentityClient) UpdateUserCapabilities(ctx context.Context, request UpdateUserCapabilitiesRequest) (response UpdateUserCapabilitiesResponse, err error)

UpdateUserCapabilities Updates the capabilities of the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUserCapabilities.go.html to see an example of how to use UpdateUserCapabilities API. A default retry strategy applies to this operation UpdateUserCapabilities()

func (IdentityClient) UpdateUserState ¶

func (client IdentityClient) UpdateUserState(ctx context.Context, request UpdateUserStateRequest) (response UpdateUserStateResponse, err error)

UpdateUserState Updates the state of the specified user.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUserState.go.html to see an example of how to use UpdateUserState API. A default retry strategy applies to this operation UpdateUserState()

func (IdentityClient) UploadApiKey ¶

func (client IdentityClient) UploadApiKey(ctx context.Context, request UploadApiKeyRequest) (response UploadApiKeyResponse, err error)

UploadApiKey Uploads an API signing key for the specified user. Every user has permission to use this operation to upload a key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to upload a key for any user, including themselves. **Important:** Even though you have permission to upload an API key, you might not yet have permission to do much else. If you try calling an operation unrelated to your own credential management (e.g., `ListUsers`, `LaunchInstance`) and receive an "unauthorized" error, check with an administrator to confirm which IAM Service group(s) you're in and what access you have. Also confirm you're working in the correct compartment. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UploadApiKey.go.html to see an example of how to use UploadApiKey API. A default retry strategy applies to this operation UploadApiKey()

type IdentityProvider ¶

type IdentityProvider interface {

	// The OCID of the `IdentityProvider`.
	GetId() *string

	// The OCID of the tenancy containing the `IdentityProvider`.
	GetCompartmentId() *string

	// The name you assign to the `IdentityProvider` during creation. The name
	// must be unique across all `IdentityProvider` objects in the tenancy and
	// cannot be changed. This is the name federated users see when choosing
	// which identity provider to use when signing in to the Oracle Cloud Infrastructure
	// Console.
	GetName() *string

	// The description you assign to the `IdentityProvider` during creation. Does
	// not have to be unique, and it's changeable.
	GetDescription() *string

	// The identity provider service or product.
	// Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft
	// Active Directory Federation Services (ADFS).
	// Allowed values are:
	// - `ADFS`
	// - `IDCS`
	// Example: `IDCS`
	GetProductType() *string

	// Date and time the `IdentityProvider` was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	GetTimeCreated() *common.SDKTime

	// The current state. After creating an `IdentityProvider`, make sure its
	// `lifecycleState` changes from CREATING to ACTIVE before using it.
	GetLifecycleState() IdentityProviderLifecycleStateEnum

	// The detailed status of INACTIVE lifecycleState.
	GetInactiveStatus() *int64

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

IdentityProvider The resulting base object when you add an identity provider to your tenancy. A Saml2IdentityProvider is a specific type of `IdentityProvider` that supports the SAML 2.0 protocol. Each `IdentityProvider` object has its own OCID. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type IdentityProviderGroupSummary ¶

type IdentityProviderGroupSummary struct {

	// The OCID of the `IdentityProviderGroup`.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the `IdentityProvider` this group belongs to.
	IdentityProviderId *string `mandatory:"false" json:"identityProviderId"`

	// Display name of the group
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Display name of the group
	Name *string `mandatory:"false" json:"name"`

	// Identifier of the group in the identity provider
	ExternalIdentifier *string `mandatory:"false" json:"externalIdentifier"`

	// Date and time the `IdentityProviderGroup` was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time the `IdentityProviderGroup` was last modified, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeModified *common.SDKTime `mandatory:"false" json:"timeModified"`
}

IdentityProviderGroupSummary A group created in an identity provider that can be mapped to a group in OCI

func (IdentityProviderGroupSummary) String ¶

func (IdentityProviderGroupSummary) ValidateEnumValue ¶

func (m IdentityProviderGroupSummary) 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

type IdentityProviderLifecycleStateEnum ¶

type IdentityProviderLifecycleStateEnum string

IdentityProviderLifecycleStateEnum Enum with underlying type: string

const (
	IdentityProviderLifecycleStateCreating IdentityProviderLifecycleStateEnum = "CREATING"
	IdentityProviderLifecycleStateActive   IdentityProviderLifecycleStateEnum = "ACTIVE"
	IdentityProviderLifecycleStateInactive IdentityProviderLifecycleStateEnum = "INACTIVE"
	IdentityProviderLifecycleStateDeleting IdentityProviderLifecycleStateEnum = "DELETING"
	IdentityProviderLifecycleStateDeleted  IdentityProviderLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for IdentityProviderLifecycleStateEnum

func GetIdentityProviderLifecycleStateEnumValues ¶

func GetIdentityProviderLifecycleStateEnumValues() []IdentityProviderLifecycleStateEnum

GetIdentityProviderLifecycleStateEnumValues Enumerates the set of values for IdentityProviderLifecycleStateEnum

func GetMappingIdentityProviderLifecycleStateEnum ¶

func GetMappingIdentityProviderLifecycleStateEnum(val string) (IdentityProviderLifecycleStateEnum, bool)

GetMappingIdentityProviderLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type IdpGroupMapping ¶

type IdpGroupMapping struct {

	// The OCID of the `IdpGroupMapping`.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the `IdentityProvider` this mapping belongs to.
	IdpId *string `mandatory:"true" json:"idpId"`

	// The name of the IdP group that is mapped to the IAM Service group.
	IdpGroupName *string `mandatory:"true" json:"idpGroupName"`

	// The OCID of the IAM Service group that is mapped to the IdP group.
	GroupId *string `mandatory:"true" json:"groupId"`

	// The OCID of the tenancy containing the `IdentityProvider`.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Date and time the mapping was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The mapping's current state.  After creating a mapping object, make sure its `lifecycleState` changes
	// from CREATING to ACTIVE before using it.
	LifecycleState IdpGroupMappingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

IdpGroupMapping A mapping between a single group defined by the identity provider (IdP) you're federating with and a single IAM Service Group in Oracle Cloud Infrastructure. For more information about group mappings and what they're for, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. But each `IdPGroupMapping` object is between only a single IdP group and IAM Service group. Each `IdPGroupMapping` object has its own OCID. **Note:** Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle Cloud Infrastructure Console.

func (IdpGroupMapping) String ¶

func (m IdpGroupMapping) String() string

func (IdpGroupMapping) ValidateEnumValue ¶

func (m IdpGroupMapping) 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

type IdpGroupMappingLifecycleStateEnum ¶

type IdpGroupMappingLifecycleStateEnum string

IdpGroupMappingLifecycleStateEnum Enum with underlying type: string

const (
	IdpGroupMappingLifecycleStateCreating IdpGroupMappingLifecycleStateEnum = "CREATING"
	IdpGroupMappingLifecycleStateActive   IdpGroupMappingLifecycleStateEnum = "ACTIVE"
	IdpGroupMappingLifecycleStateInactive IdpGroupMappingLifecycleStateEnum = "INACTIVE"
	IdpGroupMappingLifecycleStateDeleting IdpGroupMappingLifecycleStateEnum = "DELETING"
	IdpGroupMappingLifecycleStateDeleted  IdpGroupMappingLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for IdpGroupMappingLifecycleStateEnum

func GetIdpGroupMappingLifecycleStateEnumValues ¶

func GetIdpGroupMappingLifecycleStateEnumValues() []IdpGroupMappingLifecycleStateEnum

GetIdpGroupMappingLifecycleStateEnumValues Enumerates the set of values for IdpGroupMappingLifecycleStateEnum

func GetMappingIdpGroupMappingLifecycleStateEnum ¶

func GetMappingIdpGroupMappingLifecycleStateEnum(val string) (IdpGroupMappingLifecycleStateEnum, bool)

GetMappingIdpGroupMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ImportStandardTagsDetails ¶

type ImportStandardTagsDetails struct {

	// The OCID of the compartment where the bulk create request is submitted and where the tag namespaces will be created.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name of standard tag namespace that will be imported in bulk
	StandardTagNamespaceName *string `mandatory:"true" json:"standardTagNamespaceName"`
}

ImportStandardTagsDetails The representation of ImportStandardTagsDetails

func (ImportStandardTagsDetails) String ¶

func (m ImportStandardTagsDetails) String() string

func (ImportStandardTagsDetails) ValidateEnumValue ¶

func (m ImportStandardTagsDetails) 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

type ImportStandardTagsRequest ¶

type ImportStandardTagsRequest struct {

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The request object for creating or updating standard tag namespace.
	ImportStandardTagsDetails `contributesTo:"body"`

	// 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
}

ImportStandardTagsRequest wrapper for the ImportStandardTags operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ImportStandardTags.go.html to see an example of how to use ImportStandardTagsRequest.

func (ImportStandardTagsRequest) BinaryRequestBody ¶

func (request ImportStandardTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ImportStandardTagsRequest) HTTPRequest ¶

func (request ImportStandardTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ImportStandardTagsRequest) RetryPolicy ¶

func (request ImportStandardTagsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ImportStandardTagsRequest) String ¶

func (request ImportStandardTagsRequest) String() string

func (ImportStandardTagsRequest) ValidateEnumValue ¶

func (request ImportStandardTagsRequest) 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

type ImportStandardTagsResponse ¶

type ImportStandardTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

ImportStandardTagsResponse wrapper for the ImportStandardTags operation

func (ImportStandardTagsResponse) HTTPResponse ¶

func (response ImportStandardTagsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ImportStandardTagsResponse) String ¶

func (response ImportStandardTagsResponse) String() string

type ListAllowedDomainLicenseTypesRequest ¶

type ListAllowedDomainLicenseTypesRequest struct {

	// The license type of the identity domain.
	CurrentLicenseTypeName *string `mandatory:"false" contributesTo:"query" name:"currentLicenseTypeName"`

	// 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
}

ListAllowedDomainLicenseTypesRequest wrapper for the ListAllowedDomainLicenseTypes operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAllowedDomainLicenseTypes.go.html to see an example of how to use ListAllowedDomainLicenseTypesRequest.

func (ListAllowedDomainLicenseTypesRequest) BinaryRequestBody ¶

func (request ListAllowedDomainLicenseTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAllowedDomainLicenseTypesRequest) HTTPRequest ¶

func (request ListAllowedDomainLicenseTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAllowedDomainLicenseTypesRequest) RetryPolicy ¶

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAllowedDomainLicenseTypesRequest) String ¶

func (ListAllowedDomainLicenseTypesRequest) ValidateEnumValue ¶

func (request ListAllowedDomainLicenseTypesRequest) 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

type ListAllowedDomainLicenseTypesResponse ¶

type ListAllowedDomainLicenseTypesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []AllowedDomainLicenseTypeSummary instance
	Items []AllowedDomainLicenseTypeSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListAllowedDomainLicenseTypesResponse wrapper for the ListAllowedDomainLicenseTypes operation

func (ListAllowedDomainLicenseTypesResponse) HTTPResponse ¶

func (response ListAllowedDomainLicenseTypesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAllowedDomainLicenseTypesResponse) String ¶

type ListApiKeysRequest ¶

type ListApiKeysRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

ListApiKeysRequest wrapper for the ListApiKeys operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListApiKeys.go.html to see an example of how to use ListApiKeysRequest.

func (ListApiKeysRequest) BinaryRequestBody ¶

func (request ListApiKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListApiKeysRequest) HTTPRequest ¶

func (request ListApiKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListApiKeysRequest) RetryPolicy ¶

func (request ListApiKeysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListApiKeysRequest) String ¶

func (request ListApiKeysRequest) String() string

func (ListApiKeysRequest) ValidateEnumValue ¶

func (request ListApiKeysRequest) 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

type ListApiKeysResponse ¶

type ListApiKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []ApiKey instance
	Items []ApiKey `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListApiKeysResponse wrapper for the ListApiKeys operation

func (ListApiKeysResponse) HTTPResponse ¶

func (response ListApiKeysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListApiKeysResponse) String ¶

func (response ListApiKeysResponse) String() string

type ListAuthTokensRequest ¶

type ListAuthTokensRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

ListAuthTokensRequest wrapper for the ListAuthTokens operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAuthTokens.go.html to see an example of how to use ListAuthTokensRequest.

func (ListAuthTokensRequest) BinaryRequestBody ¶

func (request ListAuthTokensRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAuthTokensRequest) HTTPRequest ¶

func (request ListAuthTokensRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAuthTokensRequest) RetryPolicy ¶

func (request ListAuthTokensRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAuthTokensRequest) String ¶

func (request ListAuthTokensRequest) String() string

func (ListAuthTokensRequest) ValidateEnumValue ¶

func (request ListAuthTokensRequest) 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

type ListAuthTokensResponse ¶

type ListAuthTokensResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []AuthToken instance
	Items []AuthToken `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListAuthTokensResponse wrapper for the ListAuthTokens operation

func (ListAuthTokensResponse) HTTPResponse ¶

func (response ListAuthTokensResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAuthTokensResponse) String ¶

func (response ListAuthTokensResponse) String() string

type ListAvailabilityDomainsRequest ¶

type ListAvailabilityDomainsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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
}

ListAvailabilityDomainsRequest wrapper for the ListAvailabilityDomains operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAvailabilityDomains.go.html to see an example of how to use ListAvailabilityDomainsRequest.

func (ListAvailabilityDomainsRequest) BinaryRequestBody ¶

func (request ListAvailabilityDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAvailabilityDomainsRequest) HTTPRequest ¶

func (request ListAvailabilityDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAvailabilityDomainsRequest) RetryPolicy ¶

func (request ListAvailabilityDomainsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAvailabilityDomainsRequest) String ¶

func (request ListAvailabilityDomainsRequest) String() string

func (ListAvailabilityDomainsRequest) ValidateEnumValue ¶

func (request ListAvailabilityDomainsRequest) 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

type ListAvailabilityDomainsResponse ¶

type ListAvailabilityDomainsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []AvailabilityDomain instance
	Items []AvailabilityDomain `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListAvailabilityDomainsResponse wrapper for the ListAvailabilityDomains operation

func (ListAvailabilityDomainsResponse) HTTPResponse ¶

func (response ListAvailabilityDomainsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAvailabilityDomainsResponse) String ¶

func (response ListAvailabilityDomainsResponse) String() string

type ListBulkActionResourceTypesBulkActionTypeEnum ¶

type ListBulkActionResourceTypesBulkActionTypeEnum string

ListBulkActionResourceTypesBulkActionTypeEnum Enum with underlying type: string

const (
	ListBulkActionResourceTypesBulkActionTypeMoveResources   ListBulkActionResourceTypesBulkActionTypeEnum = "BULK_MOVE_RESOURCES"
	ListBulkActionResourceTypesBulkActionTypeDeleteResources ListBulkActionResourceTypesBulkActionTypeEnum = "BULK_DELETE_RESOURCES"
)

Set of constants representing the allowable values for ListBulkActionResourceTypesBulkActionTypeEnum

func GetListBulkActionResourceTypesBulkActionTypeEnumValues ¶

func GetListBulkActionResourceTypesBulkActionTypeEnumValues() []ListBulkActionResourceTypesBulkActionTypeEnum

GetListBulkActionResourceTypesBulkActionTypeEnumValues Enumerates the set of values for ListBulkActionResourceTypesBulkActionTypeEnum

func GetMappingListBulkActionResourceTypesBulkActionTypeEnum ¶

func GetMappingListBulkActionResourceTypesBulkActionTypeEnum(val string) (ListBulkActionResourceTypesBulkActionTypeEnum, bool)

GetMappingListBulkActionResourceTypesBulkActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBulkActionResourceTypesRequest ¶

type ListBulkActionResourceTypesRequest struct {

	// The type of bulk action.
	BulkActionType ListBulkActionResourceTypesBulkActionTypeEnum `mandatory:"true" contributesTo:"query" name:"bulkActionType" omitEmpty:"true"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListBulkActionResourceTypesRequest wrapper for the ListBulkActionResourceTypes operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListBulkActionResourceTypes.go.html to see an example of how to use ListBulkActionResourceTypesRequest.

func (ListBulkActionResourceTypesRequest) BinaryRequestBody ¶

func (request ListBulkActionResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBulkActionResourceTypesRequest) HTTPRequest ¶

func (request ListBulkActionResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBulkActionResourceTypesRequest) RetryPolicy ¶

func (request ListBulkActionResourceTypesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBulkActionResourceTypesRequest) String ¶

func (request ListBulkActionResourceTypesRequest) String() string

func (ListBulkActionResourceTypesRequest) ValidateEnumValue ¶

func (request ListBulkActionResourceTypesRequest) 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

type ListBulkActionResourceTypesResponse ¶

type ListBulkActionResourceTypesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BulkActionResourceTypeCollection instances
	BulkActionResourceTypeCollection `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBulkActionResourceTypesResponse wrapper for the ListBulkActionResourceTypes operation

func (ListBulkActionResourceTypesResponse) HTTPResponse ¶

func (response ListBulkActionResourceTypesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBulkActionResourceTypesResponse) String ¶

func (response ListBulkActionResourceTypesResponse) String() string

type ListBulkEditTagsResourceTypesRequest ¶

type ListBulkEditTagsResourceTypesRequest struct {

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListBulkEditTagsResourceTypesRequest wrapper for the ListBulkEditTagsResourceTypes operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListBulkEditTagsResourceTypes.go.html to see an example of how to use ListBulkEditTagsResourceTypesRequest.

func (ListBulkEditTagsResourceTypesRequest) BinaryRequestBody ¶

func (request ListBulkEditTagsResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBulkEditTagsResourceTypesRequest) HTTPRequest ¶

func (request ListBulkEditTagsResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBulkEditTagsResourceTypesRequest) RetryPolicy ¶

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBulkEditTagsResourceTypesRequest) String ¶

func (ListBulkEditTagsResourceTypesRequest) ValidateEnumValue ¶

func (request ListBulkEditTagsResourceTypesRequest) 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

type ListBulkEditTagsResourceTypesResponse ¶

type ListBulkEditTagsResourceTypesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BulkEditTagsResourceTypeCollection instances
	BulkEditTagsResourceTypeCollection `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBulkEditTagsResourceTypesResponse wrapper for the ListBulkEditTagsResourceTypes operation

func (ListBulkEditTagsResourceTypesResponse) HTTPResponse ¶

func (response ListBulkEditTagsResourceTypesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBulkEditTagsResourceTypesResponse) String ¶

type ListCompartmentsAccessLevelEnum ¶

type ListCompartmentsAccessLevelEnum string

ListCompartmentsAccessLevelEnum Enum with underlying type: string

const (
	ListCompartmentsAccessLevelAny        ListCompartmentsAccessLevelEnum = "ANY"
	ListCompartmentsAccessLevelAccessible ListCompartmentsAccessLevelEnum = "ACCESSIBLE"
)

Set of constants representing the allowable values for ListCompartmentsAccessLevelEnum

func GetListCompartmentsAccessLevelEnumValues ¶

func GetListCompartmentsAccessLevelEnumValues() []ListCompartmentsAccessLevelEnum

GetListCompartmentsAccessLevelEnumValues Enumerates the set of values for ListCompartmentsAccessLevelEnum

func GetMappingListCompartmentsAccessLevelEnum ¶

func GetMappingListCompartmentsAccessLevelEnum(val string) (ListCompartmentsAccessLevelEnum, bool)

GetMappingListCompartmentsAccessLevelEnum performs case Insensitive comparison on enum value and return the desired enum

type ListCompartmentsRequest ¶

type ListCompartmentsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`.
	// Setting this to `ACCESSIBLE` returns only those compartments for which the
	// user has INSPECT permissions directly or indirectly (permissions can be on a
	// resource in a subcompartment). For the compartments on which the user indirectly has
	// INSPECT permissions, a restricted set of fields is returned.
	// When set to `ANY` permissions are not checked.
	AccessLevel ListCompartmentsAccessLevelEnum `mandatory:"false" contributesTo:"query" name:"accessLevel" omitEmpty:"true"`

	// Default is false. Can only be set to true when performing
	// ListCompartments on the tenancy (root compartment).
	// When set to true, the hierarchy of compartments is traversed
	// and all compartments and subcompartments in the tenancy are
	// returned depending on the the setting of `accessLevel`.
	CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListCompartmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListCompartmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState CompartmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListCompartmentsRequest wrapper for the ListCompartments operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCompartments.go.html to see an example of how to use ListCompartmentsRequest.

func (ListCompartmentsRequest) BinaryRequestBody ¶

func (request ListCompartmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListCompartmentsRequest) HTTPRequest ¶

func (request ListCompartmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCompartmentsRequest) RetryPolicy ¶

func (request ListCompartmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCompartmentsRequest) String ¶

func (request ListCompartmentsRequest) String() string

func (ListCompartmentsRequest) ValidateEnumValue ¶

func (request ListCompartmentsRequest) 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

type ListCompartmentsResponse ¶

type ListCompartmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Compartment instances
	Items []Compartment `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListCompartmentsResponse wrapper for the ListCompartments operation

func (ListCompartmentsResponse) HTTPResponse ¶

func (response ListCompartmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCompartmentsResponse) String ¶

func (response ListCompartmentsResponse) String() string

type ListCompartmentsSortByEnum ¶

type ListCompartmentsSortByEnum string

ListCompartmentsSortByEnum Enum with underlying type: string

const (
	ListCompartmentsSortByTimecreated ListCompartmentsSortByEnum = "TIMECREATED"
	ListCompartmentsSortByName        ListCompartmentsSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListCompartmentsSortByEnum

func GetListCompartmentsSortByEnumValues ¶

func GetListCompartmentsSortByEnumValues() []ListCompartmentsSortByEnum

GetListCompartmentsSortByEnumValues Enumerates the set of values for ListCompartmentsSortByEnum

func GetMappingListCompartmentsSortByEnum ¶

func GetMappingListCompartmentsSortByEnum(val string) (ListCompartmentsSortByEnum, bool)

GetMappingListCompartmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListCompartmentsSortOrderEnum ¶

type ListCompartmentsSortOrderEnum string

ListCompartmentsSortOrderEnum Enum with underlying type: string

const (
	ListCompartmentsSortOrderAsc  ListCompartmentsSortOrderEnum = "ASC"
	ListCompartmentsSortOrderDesc ListCompartmentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCompartmentsSortOrderEnum

func GetListCompartmentsSortOrderEnumValues ¶

func GetListCompartmentsSortOrderEnumValues() []ListCompartmentsSortOrderEnum

GetListCompartmentsSortOrderEnumValues Enumerates the set of values for ListCompartmentsSortOrderEnum

func GetMappingListCompartmentsSortOrderEnum ¶

func GetMappingListCompartmentsSortOrderEnum(val string) (ListCompartmentsSortOrderEnum, bool)

GetMappingListCompartmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListCostTrackingTagsRequest ¶

type ListCostTrackingTagsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListCostTrackingTagsRequest wrapper for the ListCostTrackingTags operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCostTrackingTags.go.html to see an example of how to use ListCostTrackingTagsRequest.

func (ListCostTrackingTagsRequest) BinaryRequestBody ¶

func (request ListCostTrackingTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListCostTrackingTagsRequest) HTTPRequest ¶

func (request ListCostTrackingTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCostTrackingTagsRequest) RetryPolicy ¶

func (request ListCostTrackingTagsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCostTrackingTagsRequest) String ¶

func (request ListCostTrackingTagsRequest) String() string

func (ListCostTrackingTagsRequest) ValidateEnumValue ¶

func (request ListCostTrackingTagsRequest) 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

type ListCostTrackingTagsResponse ¶

type ListCostTrackingTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Tag instances
	Items []Tag `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"`

	// For pagination of a list of cost tracking tag. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items. For important details about how pagination works,
	// see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListCostTrackingTagsResponse wrapper for the ListCostTrackingTags operation

func (ListCostTrackingTagsResponse) HTTPResponse ¶

func (response ListCostTrackingTagsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCostTrackingTagsResponse) String ¶

func (response ListCostTrackingTagsResponse) String() string

type ListCustomerSecretKeysRequest ¶

type ListCustomerSecretKeysRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

ListCustomerSecretKeysRequest wrapper for the ListCustomerSecretKeys operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCustomerSecretKeys.go.html to see an example of how to use ListCustomerSecretKeysRequest.

func (ListCustomerSecretKeysRequest) BinaryRequestBody ¶

func (request ListCustomerSecretKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListCustomerSecretKeysRequest) HTTPRequest ¶

func (request ListCustomerSecretKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCustomerSecretKeysRequest) RetryPolicy ¶

func (request ListCustomerSecretKeysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCustomerSecretKeysRequest) String ¶

func (request ListCustomerSecretKeysRequest) String() string

func (ListCustomerSecretKeysRequest) ValidateEnumValue ¶

func (request ListCustomerSecretKeysRequest) 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

type ListCustomerSecretKeysResponse ¶

type ListCustomerSecretKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []CustomerSecretKeySummary instance
	Items []CustomerSecretKeySummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListCustomerSecretKeysResponse wrapper for the ListCustomerSecretKeys operation

func (ListCustomerSecretKeysResponse) HTTPResponse ¶

func (response ListCustomerSecretKeysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCustomerSecretKeysResponse) String ¶

func (response ListCustomerSecretKeysResponse) String() string

type ListDbCredentialsRequest ¶

type ListDbCredentialsRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListDbCredentialsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListDbCredentialsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState DbCredentialLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListDbCredentialsRequest wrapper for the ListDbCredentials operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDbCredentials.go.html to see an example of how to use ListDbCredentialsRequest.

func (ListDbCredentialsRequest) BinaryRequestBody ¶

func (request ListDbCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDbCredentialsRequest) HTTPRequest ¶

func (request ListDbCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDbCredentialsRequest) RetryPolicy ¶

func (request ListDbCredentialsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDbCredentialsRequest) String ¶

func (request ListDbCredentialsRequest) String() string

func (ListDbCredentialsRequest) ValidateEnumValue ¶

func (request ListDbCredentialsRequest) 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

type ListDbCredentialsResponse ¶

type ListDbCredentialsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DbCredentialSummary instances
	Items []DbCredentialSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDbCredentialsResponse wrapper for the ListDbCredentials operation

func (ListDbCredentialsResponse) HTTPResponse ¶

func (response ListDbCredentialsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDbCredentialsResponse) String ¶

func (response ListDbCredentialsResponse) String() string

type ListDbCredentialsSortByEnum ¶

type ListDbCredentialsSortByEnum string

ListDbCredentialsSortByEnum Enum with underlying type: string

const (
	ListDbCredentialsSortByTimecreated ListDbCredentialsSortByEnum = "TIMECREATED"
	ListDbCredentialsSortByName        ListDbCredentialsSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListDbCredentialsSortByEnum

func GetListDbCredentialsSortByEnumValues ¶

func GetListDbCredentialsSortByEnumValues() []ListDbCredentialsSortByEnum

GetListDbCredentialsSortByEnumValues Enumerates the set of values for ListDbCredentialsSortByEnum

func GetMappingListDbCredentialsSortByEnum ¶

func GetMappingListDbCredentialsSortByEnum(val string) (ListDbCredentialsSortByEnum, bool)

GetMappingListDbCredentialsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDbCredentialsSortOrderEnum ¶

type ListDbCredentialsSortOrderEnum string

ListDbCredentialsSortOrderEnum Enum with underlying type: string

const (
	ListDbCredentialsSortOrderAsc  ListDbCredentialsSortOrderEnum = "ASC"
	ListDbCredentialsSortOrderDesc ListDbCredentialsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDbCredentialsSortOrderEnum

func GetListDbCredentialsSortOrderEnumValues ¶

func GetListDbCredentialsSortOrderEnumValues() []ListDbCredentialsSortOrderEnum

GetListDbCredentialsSortOrderEnumValues Enumerates the set of values for ListDbCredentialsSortOrderEnum

func GetMappingListDbCredentialsSortOrderEnum ¶

func GetMappingListDbCredentialsSortOrderEnum(val string) (ListDbCredentialsSortOrderEnum, bool)

GetMappingListDbCredentialsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDomainsRequest ¶

type ListDomainsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The mutable display name of the identity domain.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The region-agnostic identity domain URL.
	Url *string `mandatory:"false" contributesTo:"query" name:"url"`

	// The region-specific identity domain URL.
	HomeRegionUrl *string `mandatory:"false" contributesTo:"query" name:"homeRegionUrl"`

	// The identity domain type.
	Type *string `mandatory:"false" contributesTo:"query" name:"type"`

	// The license type of the identity domain.
	LicenseType *string `mandatory:"false" contributesTo:"query" name:"licenseType"`

	// Indicates whether or not the identity domain is visible at the sign-in screen.
	IsHiddenOnLogin *bool `mandatory:"false" contributesTo:"query" name:"isHiddenOnLogin"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListDomainsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListDomainsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

	// A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
	LifecycleState DomainLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListDomainsRequest wrapper for the ListDomains operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDomains.go.html to see an example of how to use ListDomainsRequest.

func (ListDomainsRequest) BinaryRequestBody ¶

func (request ListDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDomainsRequest) HTTPRequest ¶

func (request ListDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDomainsRequest) RetryPolicy ¶

func (request ListDomainsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDomainsRequest) String ¶

func (request ListDomainsRequest) String() string

func (ListDomainsRequest) ValidateEnumValue ¶

func (request ListDomainsRequest) 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

type ListDomainsResponse ¶

type ListDomainsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DomainSummary instances
	Items []DomainSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDomainsResponse wrapper for the ListDomains operation

func (ListDomainsResponse) HTTPResponse ¶

func (response ListDomainsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDomainsResponse) String ¶

func (response ListDomainsResponse) String() string

type ListDomainsSortByEnum ¶

type ListDomainsSortByEnum string

ListDomainsSortByEnum Enum with underlying type: string

const (
	ListDomainsSortByTimecreated ListDomainsSortByEnum = "TIMECREATED"
	ListDomainsSortByName        ListDomainsSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListDomainsSortByEnum

func GetListDomainsSortByEnumValues ¶

func GetListDomainsSortByEnumValues() []ListDomainsSortByEnum

GetListDomainsSortByEnumValues Enumerates the set of values for ListDomainsSortByEnum

func GetMappingListDomainsSortByEnum ¶

func GetMappingListDomainsSortByEnum(val string) (ListDomainsSortByEnum, bool)

GetMappingListDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDomainsSortOrderEnum ¶

type ListDomainsSortOrderEnum string

ListDomainsSortOrderEnum Enum with underlying type: string

const (
	ListDomainsSortOrderAsc  ListDomainsSortOrderEnum = "ASC"
	ListDomainsSortOrderDesc ListDomainsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDomainsSortOrderEnum

func GetListDomainsSortOrderEnumValues ¶

func GetListDomainsSortOrderEnumValues() []ListDomainsSortOrderEnum

GetListDomainsSortOrderEnumValues Enumerates the set of values for ListDomainsSortOrderEnum

func GetMappingListDomainsSortOrderEnum ¶

func GetMappingListDomainsSortOrderEnum(val string) (ListDomainsSortOrderEnum, bool)

GetMappingListDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDynamicGroupsRequest ¶

type ListDynamicGroupsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListDynamicGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListDynamicGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState DynamicGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListDynamicGroupsRequest wrapper for the ListDynamicGroups operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDynamicGroups.go.html to see an example of how to use ListDynamicGroupsRequest.

func (ListDynamicGroupsRequest) BinaryRequestBody ¶

func (request ListDynamicGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDynamicGroupsRequest) HTTPRequest ¶

func (request ListDynamicGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDynamicGroupsRequest) RetryPolicy ¶

func (request ListDynamicGroupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDynamicGroupsRequest) String ¶

func (request ListDynamicGroupsRequest) String() string

func (ListDynamicGroupsRequest) ValidateEnumValue ¶

func (request ListDynamicGroupsRequest) 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

type ListDynamicGroupsResponse ¶

type ListDynamicGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DynamicGroup instances
	Items []DynamicGroup `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDynamicGroupsResponse wrapper for the ListDynamicGroups operation

func (ListDynamicGroupsResponse) HTTPResponse ¶

func (response ListDynamicGroupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDynamicGroupsResponse) String ¶

func (response ListDynamicGroupsResponse) String() string

type ListDynamicGroupsSortByEnum ¶

type ListDynamicGroupsSortByEnum string

ListDynamicGroupsSortByEnum Enum with underlying type: string

const (
	ListDynamicGroupsSortByTimecreated ListDynamicGroupsSortByEnum = "TIMECREATED"
	ListDynamicGroupsSortByName        ListDynamicGroupsSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListDynamicGroupsSortByEnum

func GetListDynamicGroupsSortByEnumValues ¶

func GetListDynamicGroupsSortByEnumValues() []ListDynamicGroupsSortByEnum

GetListDynamicGroupsSortByEnumValues Enumerates the set of values for ListDynamicGroupsSortByEnum

func GetMappingListDynamicGroupsSortByEnum ¶

func GetMappingListDynamicGroupsSortByEnum(val string) (ListDynamicGroupsSortByEnum, bool)

GetMappingListDynamicGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDynamicGroupsSortOrderEnum ¶

type ListDynamicGroupsSortOrderEnum string

ListDynamicGroupsSortOrderEnum Enum with underlying type: string

const (
	ListDynamicGroupsSortOrderAsc  ListDynamicGroupsSortOrderEnum = "ASC"
	ListDynamicGroupsSortOrderDesc ListDynamicGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDynamicGroupsSortOrderEnum

func GetListDynamicGroupsSortOrderEnumValues ¶

func GetListDynamicGroupsSortOrderEnumValues() []ListDynamicGroupsSortOrderEnum

GetListDynamicGroupsSortOrderEnumValues Enumerates the set of values for ListDynamicGroupsSortOrderEnum

func GetMappingListDynamicGroupsSortOrderEnum ¶

func GetMappingListDynamicGroupsSortOrderEnum(val string) (ListDynamicGroupsSortOrderEnum, bool)

GetMappingListDynamicGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListFaultDomainsRequest ¶

type ListFaultDomainsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availabilityDomain.
	AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

	// 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
}

ListFaultDomainsRequest wrapper for the ListFaultDomains operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListFaultDomains.go.html to see an example of how to use ListFaultDomainsRequest.

func (ListFaultDomainsRequest) BinaryRequestBody ¶

func (request ListFaultDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListFaultDomainsRequest) HTTPRequest ¶

func (request ListFaultDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListFaultDomainsRequest) RetryPolicy ¶

func (request ListFaultDomainsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListFaultDomainsRequest) String ¶

func (request ListFaultDomainsRequest) String() string

func (ListFaultDomainsRequest) ValidateEnumValue ¶

func (request ListFaultDomainsRequest) 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

type ListFaultDomainsResponse ¶

type ListFaultDomainsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []FaultDomain instance
	Items []FaultDomain `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"`
}

ListFaultDomainsResponse wrapper for the ListFaultDomains operation

func (ListFaultDomainsResponse) HTTPResponse ¶

func (response ListFaultDomainsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListFaultDomainsResponse) String ¶

func (response ListFaultDomainsResponse) String() string

type ListGroupsRequest ¶

type ListGroupsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState GroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListGroupsRequest wrapper for the ListGroups operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListGroups.go.html to see an example of how to use ListGroupsRequest.

func (ListGroupsRequest) BinaryRequestBody ¶

func (request ListGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListGroupsRequest) HTTPRequest ¶

func (request ListGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListGroupsRequest) RetryPolicy ¶

func (request ListGroupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListGroupsRequest) String ¶

func (request ListGroupsRequest) String() string

func (ListGroupsRequest) ValidateEnumValue ¶

func (request ListGroupsRequest) 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

type ListGroupsResponse ¶

type ListGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Group instances
	Items []Group `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListGroupsResponse wrapper for the ListGroups operation

func (ListGroupsResponse) HTTPResponse ¶

func (response ListGroupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListGroupsResponse) String ¶

func (response ListGroupsResponse) String() string

type ListGroupsSortByEnum ¶

type ListGroupsSortByEnum string

ListGroupsSortByEnum Enum with underlying type: string

const (
	ListGroupsSortByTimecreated ListGroupsSortByEnum = "TIMECREATED"
	ListGroupsSortByName        ListGroupsSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListGroupsSortByEnum

func GetListGroupsSortByEnumValues ¶

func GetListGroupsSortByEnumValues() []ListGroupsSortByEnum

GetListGroupsSortByEnumValues Enumerates the set of values for ListGroupsSortByEnum

func GetMappingListGroupsSortByEnum ¶

func GetMappingListGroupsSortByEnum(val string) (ListGroupsSortByEnum, bool)

GetMappingListGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListGroupsSortOrderEnum ¶

type ListGroupsSortOrderEnum string

ListGroupsSortOrderEnum Enum with underlying type: string

const (
	ListGroupsSortOrderAsc  ListGroupsSortOrderEnum = "ASC"
	ListGroupsSortOrderDesc ListGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListGroupsSortOrderEnum

func GetListGroupsSortOrderEnumValues ¶

func GetListGroupsSortOrderEnumValues() []ListGroupsSortOrderEnum

GetListGroupsSortOrderEnumValues Enumerates the set of values for ListGroupsSortOrderEnum

func GetMappingListGroupsSortOrderEnum ¶

func GetMappingListGroupsSortOrderEnum(val string) (ListGroupsSortOrderEnum, bool)

GetMappingListGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIamWorkRequestErrorsRequest ¶

type ListIamWorkRequestErrorsRequest struct {

	// The OCID of the IAM work request.
	IamWorkRequestId *string `mandatory:"true" contributesTo:"path" name:"iamWorkRequestId"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListIamWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListIamWorkRequestErrorsRequest wrapper for the ListIamWorkRequestErrors operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequestErrors.go.html to see an example of how to use ListIamWorkRequestErrorsRequest.

func (ListIamWorkRequestErrorsRequest) BinaryRequestBody ¶

func (request ListIamWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIamWorkRequestErrorsRequest) HTTPRequest ¶

func (request ListIamWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIamWorkRequestErrorsRequest) RetryPolicy ¶

func (request ListIamWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIamWorkRequestErrorsRequest) String ¶

func (request ListIamWorkRequestErrorsRequest) String() string

func (ListIamWorkRequestErrorsRequest) ValidateEnumValue ¶

func (request ListIamWorkRequestErrorsRequest) 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

type ListIamWorkRequestErrorsResponse ¶

type ListIamWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IamWorkRequestErrorSummary instances
	Items []IamWorkRequestErrorSummary `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages of
	// results remain. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListIamWorkRequestErrorsResponse wrapper for the ListIamWorkRequestErrors operation

func (ListIamWorkRequestErrorsResponse) HTTPResponse ¶

func (response ListIamWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIamWorkRequestErrorsResponse) String ¶

func (response ListIamWorkRequestErrorsResponse) String() string

type ListIamWorkRequestErrorsSortOrderEnum ¶

type ListIamWorkRequestErrorsSortOrderEnum string

ListIamWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListIamWorkRequestErrorsSortOrderAsc  ListIamWorkRequestErrorsSortOrderEnum = "ASC"
	ListIamWorkRequestErrorsSortOrderDesc ListIamWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIamWorkRequestErrorsSortOrderEnum

func GetListIamWorkRequestErrorsSortOrderEnumValues ¶

func GetListIamWorkRequestErrorsSortOrderEnumValues() []ListIamWorkRequestErrorsSortOrderEnum

GetListIamWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListIamWorkRequestErrorsSortOrderEnum

func GetMappingListIamWorkRequestErrorsSortOrderEnum ¶

func GetMappingListIamWorkRequestErrorsSortOrderEnum(val string) (ListIamWorkRequestErrorsSortOrderEnum, bool)

GetMappingListIamWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIamWorkRequestLogsRequest ¶

type ListIamWorkRequestLogsRequest struct {

	// The OCID of the IAM work request.
	IamWorkRequestId *string `mandatory:"true" contributesTo:"path" name:"iamWorkRequestId"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListIamWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListIamWorkRequestLogsRequest wrapper for the ListIamWorkRequestLogs operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequestLogs.go.html to see an example of how to use ListIamWorkRequestLogsRequest.

func (ListIamWorkRequestLogsRequest) BinaryRequestBody ¶

func (request ListIamWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIamWorkRequestLogsRequest) HTTPRequest ¶

func (request ListIamWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIamWorkRequestLogsRequest) RetryPolicy ¶

func (request ListIamWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIamWorkRequestLogsRequest) String ¶

func (request ListIamWorkRequestLogsRequest) String() string

func (ListIamWorkRequestLogsRequest) ValidateEnumValue ¶

func (request ListIamWorkRequestLogsRequest) 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

type ListIamWorkRequestLogsResponse ¶

type ListIamWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IamWorkRequestLogSummary instances
	Items []IamWorkRequestLogSummary `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"`

	// The number of seconds that the client should wait before polling again.
	RetryAfter *float32 `presentIn:"header" name:"retry-after"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListIamWorkRequestLogsResponse wrapper for the ListIamWorkRequestLogs operation

func (ListIamWorkRequestLogsResponse) HTTPResponse ¶

func (response ListIamWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIamWorkRequestLogsResponse) String ¶

func (response ListIamWorkRequestLogsResponse) String() string

type ListIamWorkRequestLogsSortOrderEnum ¶

type ListIamWorkRequestLogsSortOrderEnum string

ListIamWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListIamWorkRequestLogsSortOrderAsc  ListIamWorkRequestLogsSortOrderEnum = "ASC"
	ListIamWorkRequestLogsSortOrderDesc ListIamWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIamWorkRequestLogsSortOrderEnum

func GetListIamWorkRequestLogsSortOrderEnumValues ¶

func GetListIamWorkRequestLogsSortOrderEnumValues() []ListIamWorkRequestLogsSortOrderEnum

GetListIamWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListIamWorkRequestLogsSortOrderEnum

func GetMappingListIamWorkRequestLogsSortOrderEnum ¶

func GetMappingListIamWorkRequestLogsSortOrderEnum(val string) (ListIamWorkRequestLogsSortOrderEnum, bool)

GetMappingListIamWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIamWorkRequestsRequest ¶

type ListIamWorkRequestsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The identifier of the resource the work request affects.
	ResourceIdentifier *string `mandatory:"false" contributesTo:"query" name:"resourceIdentifier"`

	// 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
}

ListIamWorkRequestsRequest wrapper for the ListIamWorkRequests operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequests.go.html to see an example of how to use ListIamWorkRequestsRequest.

func (ListIamWorkRequestsRequest) BinaryRequestBody ¶

func (request ListIamWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIamWorkRequestsRequest) HTTPRequest ¶

func (request ListIamWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIamWorkRequestsRequest) RetryPolicy ¶

func (request ListIamWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIamWorkRequestsRequest) String ¶

func (request ListIamWorkRequestsRequest) String() string

func (ListIamWorkRequestsRequest) ValidateEnumValue ¶

func (request ListIamWorkRequestsRequest) 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

type ListIamWorkRequestsResponse ¶

type ListIamWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IamWorkRequestSummary instances
	Items []IamWorkRequestSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListIamWorkRequestsResponse wrapper for the ListIamWorkRequests operation

func (ListIamWorkRequestsResponse) HTTPResponse ¶

func (response ListIamWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIamWorkRequestsResponse) String ¶

func (response ListIamWorkRequestsResponse) String() string

type ListIdentityProviderGroupsRequest ¶

type ListIdentityProviderGroupsRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState IdentityProviderLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListIdentityProviderGroupsRequest wrapper for the ListIdentityProviderGroups operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdentityProviderGroups.go.html to see an example of how to use ListIdentityProviderGroupsRequest.

func (ListIdentityProviderGroupsRequest) BinaryRequestBody ¶

func (request ListIdentityProviderGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIdentityProviderGroupsRequest) HTTPRequest ¶

func (request ListIdentityProviderGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIdentityProviderGroupsRequest) RetryPolicy ¶

func (request ListIdentityProviderGroupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIdentityProviderGroupsRequest) String ¶

func (request ListIdentityProviderGroupsRequest) String() string

func (ListIdentityProviderGroupsRequest) ValidateEnumValue ¶

func (request ListIdentityProviderGroupsRequest) 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

type ListIdentityProviderGroupsResponse ¶

type ListIdentityProviderGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IdentityProviderGroupSummary instances
	Items []IdentityProviderGroupSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListIdentityProviderGroupsResponse wrapper for the ListIdentityProviderGroups operation

func (ListIdentityProviderGroupsResponse) HTTPResponse ¶

func (response ListIdentityProviderGroupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIdentityProviderGroupsResponse) String ¶

func (response ListIdentityProviderGroupsResponse) String() string

type ListIdentityProvidersProtocolEnum ¶

type ListIdentityProvidersProtocolEnum string

ListIdentityProvidersProtocolEnum Enum with underlying type: string

const (
	ListIdentityProvidersProtocolSaml2 ListIdentityProvidersProtocolEnum = "SAML2"
)

Set of constants representing the allowable values for ListIdentityProvidersProtocolEnum

func GetListIdentityProvidersProtocolEnumValues ¶

func GetListIdentityProvidersProtocolEnumValues() []ListIdentityProvidersProtocolEnum

GetListIdentityProvidersProtocolEnumValues Enumerates the set of values for ListIdentityProvidersProtocolEnum

func GetMappingListIdentityProvidersProtocolEnum ¶

func GetMappingListIdentityProvidersProtocolEnum(val string) (ListIdentityProvidersProtocolEnum, bool)

GetMappingListIdentityProvidersProtocolEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIdentityProvidersRequest ¶

type ListIdentityProvidersRequest struct {

	// The protocol used for federation.
	Protocol ListIdentityProvidersProtocolEnum `mandatory:"true" contributesTo:"query" name:"protocol" omitEmpty:"true"`

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListIdentityProvidersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListIdentityProvidersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState IdentityProviderLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListIdentityProvidersRequest wrapper for the ListIdentityProviders operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdentityProviders.go.html to see an example of how to use ListIdentityProvidersRequest.

func (ListIdentityProvidersRequest) BinaryRequestBody ¶

func (request ListIdentityProvidersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIdentityProvidersRequest) HTTPRequest ¶

func (request ListIdentityProvidersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIdentityProvidersRequest) RetryPolicy ¶

func (request ListIdentityProvidersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIdentityProvidersRequest) String ¶

func (request ListIdentityProvidersRequest) String() string

func (ListIdentityProvidersRequest) ValidateEnumValue ¶

func (request ListIdentityProvidersRequest) 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

type ListIdentityProvidersResponse ¶

type ListIdentityProvidersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IdentityProvider instances
	Items []IdentityProvider `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListIdentityProvidersResponse wrapper for the ListIdentityProviders operation

func (ListIdentityProvidersResponse) HTTPResponse ¶

func (response ListIdentityProvidersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIdentityProvidersResponse) String ¶

func (response ListIdentityProvidersResponse) String() string

type ListIdentityProvidersSortByEnum ¶

type ListIdentityProvidersSortByEnum string

ListIdentityProvidersSortByEnum Enum with underlying type: string

const (
	ListIdentityProvidersSortByTimecreated ListIdentityProvidersSortByEnum = "TIMECREATED"
	ListIdentityProvidersSortByName        ListIdentityProvidersSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListIdentityProvidersSortByEnum

func GetListIdentityProvidersSortByEnumValues ¶

func GetListIdentityProvidersSortByEnumValues() []ListIdentityProvidersSortByEnum

GetListIdentityProvidersSortByEnumValues Enumerates the set of values for ListIdentityProvidersSortByEnum

func GetMappingListIdentityProvidersSortByEnum ¶

func GetMappingListIdentityProvidersSortByEnum(val string) (ListIdentityProvidersSortByEnum, bool)

GetMappingListIdentityProvidersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIdentityProvidersSortOrderEnum ¶

type ListIdentityProvidersSortOrderEnum string

ListIdentityProvidersSortOrderEnum Enum with underlying type: string

const (
	ListIdentityProvidersSortOrderAsc  ListIdentityProvidersSortOrderEnum = "ASC"
	ListIdentityProvidersSortOrderDesc ListIdentityProvidersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIdentityProvidersSortOrderEnum

func GetListIdentityProvidersSortOrderEnumValues ¶

func GetListIdentityProvidersSortOrderEnumValues() []ListIdentityProvidersSortOrderEnum

GetListIdentityProvidersSortOrderEnumValues Enumerates the set of values for ListIdentityProvidersSortOrderEnum

func GetMappingListIdentityProvidersSortOrderEnum ¶

func GetMappingListIdentityProvidersSortOrderEnum(val string) (ListIdentityProvidersSortOrderEnum, bool)

GetMappingListIdentityProvidersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIdpGroupMappingsRequest ¶

type ListIdpGroupMappingsRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListIdpGroupMappingsRequest wrapper for the ListIdpGroupMappings operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdpGroupMappings.go.html to see an example of how to use ListIdpGroupMappingsRequest.

func (ListIdpGroupMappingsRequest) BinaryRequestBody ¶

func (request ListIdpGroupMappingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIdpGroupMappingsRequest) HTTPRequest ¶

func (request ListIdpGroupMappingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIdpGroupMappingsRequest) RetryPolicy ¶

func (request ListIdpGroupMappingsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIdpGroupMappingsRequest) String ¶

func (request ListIdpGroupMappingsRequest) String() string

func (ListIdpGroupMappingsRequest) ValidateEnumValue ¶

func (request ListIdpGroupMappingsRequest) 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

type ListIdpGroupMappingsResponse ¶

type ListIdpGroupMappingsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IdpGroupMapping instances
	Items []IdpGroupMapping `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListIdpGroupMappingsResponse wrapper for the ListIdpGroupMappings operation

func (ListIdpGroupMappingsResponse) HTTPResponse ¶

func (response ListIdpGroupMappingsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIdpGroupMappingsResponse) String ¶

func (response ListIdpGroupMappingsResponse) String() string

type ListMfaTotpDevicesRequest ¶

type ListMfaTotpDevicesRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListMfaTotpDevicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListMfaTotpDevicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListMfaTotpDevicesRequest wrapper for the ListMfaTotpDevices operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListMfaTotpDevices.go.html to see an example of how to use ListMfaTotpDevicesRequest.

func (ListMfaTotpDevicesRequest) BinaryRequestBody ¶

func (request ListMfaTotpDevicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListMfaTotpDevicesRequest) HTTPRequest ¶

func (request ListMfaTotpDevicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListMfaTotpDevicesRequest) RetryPolicy ¶

func (request ListMfaTotpDevicesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListMfaTotpDevicesRequest) String ¶

func (request ListMfaTotpDevicesRequest) String() string

func (ListMfaTotpDevicesRequest) ValidateEnumValue ¶

func (request ListMfaTotpDevicesRequest) 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

type ListMfaTotpDevicesResponse ¶

type ListMfaTotpDevicesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []MfaTotpDeviceSummary instances
	Items []MfaTotpDeviceSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListMfaTotpDevicesResponse wrapper for the ListMfaTotpDevices operation

func (ListMfaTotpDevicesResponse) HTTPResponse ¶

func (response ListMfaTotpDevicesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListMfaTotpDevicesResponse) String ¶

func (response ListMfaTotpDevicesResponse) String() string

type ListMfaTotpDevicesSortByEnum ¶

type ListMfaTotpDevicesSortByEnum string

ListMfaTotpDevicesSortByEnum Enum with underlying type: string

const (
	ListMfaTotpDevicesSortByTimecreated ListMfaTotpDevicesSortByEnum = "TIMECREATED"
	ListMfaTotpDevicesSortByName        ListMfaTotpDevicesSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListMfaTotpDevicesSortByEnum

func GetListMfaTotpDevicesSortByEnumValues ¶

func GetListMfaTotpDevicesSortByEnumValues() []ListMfaTotpDevicesSortByEnum

GetListMfaTotpDevicesSortByEnumValues Enumerates the set of values for ListMfaTotpDevicesSortByEnum

func GetMappingListMfaTotpDevicesSortByEnum ¶

func GetMappingListMfaTotpDevicesSortByEnum(val string) (ListMfaTotpDevicesSortByEnum, bool)

GetMappingListMfaTotpDevicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListMfaTotpDevicesSortOrderEnum ¶

type ListMfaTotpDevicesSortOrderEnum string

ListMfaTotpDevicesSortOrderEnum Enum with underlying type: string

const (
	ListMfaTotpDevicesSortOrderAsc  ListMfaTotpDevicesSortOrderEnum = "ASC"
	ListMfaTotpDevicesSortOrderDesc ListMfaTotpDevicesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListMfaTotpDevicesSortOrderEnum

func GetListMfaTotpDevicesSortOrderEnumValues ¶

func GetListMfaTotpDevicesSortOrderEnumValues() []ListMfaTotpDevicesSortOrderEnum

GetListMfaTotpDevicesSortOrderEnumValues Enumerates the set of values for ListMfaTotpDevicesSortOrderEnum

func GetMappingListMfaTotpDevicesSortOrderEnum ¶

func GetMappingListMfaTotpDevicesSortOrderEnum(val string) (ListMfaTotpDevicesSortOrderEnum, bool)

GetMappingListMfaTotpDevicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListNetworkSourcesRequest ¶

type ListNetworkSourcesRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListNetworkSourcesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListNetworkSourcesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState NetworkSourcesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListNetworkSourcesRequest wrapper for the ListNetworkSources operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListNetworkSources.go.html to see an example of how to use ListNetworkSourcesRequest.

func (ListNetworkSourcesRequest) BinaryRequestBody ¶

func (request ListNetworkSourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListNetworkSourcesRequest) HTTPRequest ¶

func (request ListNetworkSourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListNetworkSourcesRequest) RetryPolicy ¶

func (request ListNetworkSourcesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListNetworkSourcesRequest) String ¶

func (request ListNetworkSourcesRequest) String() string

func (ListNetworkSourcesRequest) ValidateEnumValue ¶

func (request ListNetworkSourcesRequest) 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

type ListNetworkSourcesResponse ¶

type ListNetworkSourcesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []NetworkSourcesSummary instances
	Items []NetworkSourcesSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListNetworkSourcesResponse wrapper for the ListNetworkSources operation

func (ListNetworkSourcesResponse) HTTPResponse ¶

func (response ListNetworkSourcesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListNetworkSourcesResponse) String ¶

func (response ListNetworkSourcesResponse) String() string

type ListNetworkSourcesSortByEnum ¶

type ListNetworkSourcesSortByEnum string

ListNetworkSourcesSortByEnum Enum with underlying type: string

const (
	ListNetworkSourcesSortByTimecreated ListNetworkSourcesSortByEnum = "TIMECREATED"
	ListNetworkSourcesSortByName        ListNetworkSourcesSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListNetworkSourcesSortByEnum

func GetListNetworkSourcesSortByEnumValues ¶

func GetListNetworkSourcesSortByEnumValues() []ListNetworkSourcesSortByEnum

GetListNetworkSourcesSortByEnumValues Enumerates the set of values for ListNetworkSourcesSortByEnum

func GetMappingListNetworkSourcesSortByEnum ¶

func GetMappingListNetworkSourcesSortByEnum(val string) (ListNetworkSourcesSortByEnum, bool)

GetMappingListNetworkSourcesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListNetworkSourcesSortOrderEnum ¶

type ListNetworkSourcesSortOrderEnum string

ListNetworkSourcesSortOrderEnum Enum with underlying type: string

const (
	ListNetworkSourcesSortOrderAsc  ListNetworkSourcesSortOrderEnum = "ASC"
	ListNetworkSourcesSortOrderDesc ListNetworkSourcesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListNetworkSourcesSortOrderEnum

func GetListNetworkSourcesSortOrderEnumValues ¶

func GetListNetworkSourcesSortOrderEnumValues() []ListNetworkSourcesSortOrderEnum

GetListNetworkSourcesSortOrderEnumValues Enumerates the set of values for ListNetworkSourcesSortOrderEnum

func GetMappingListNetworkSourcesSortOrderEnum ¶

func GetMappingListNetworkSourcesSortOrderEnum(val string) (ListNetworkSourcesSortOrderEnum, bool)

GetMappingListNetworkSourcesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOAuthClientCredentialsRequest ¶

type ListOAuthClientCredentialsRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState OAuth2ClientCredentialSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListOAuthClientCredentialsRequest wrapper for the ListOAuthClientCredentials operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListOAuthClientCredentials.go.html to see an example of how to use ListOAuthClientCredentialsRequest.

func (ListOAuthClientCredentialsRequest) BinaryRequestBody ¶

func (request ListOAuthClientCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListOAuthClientCredentialsRequest) HTTPRequest ¶

func (request ListOAuthClientCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOAuthClientCredentialsRequest) RetryPolicy ¶

func (request ListOAuthClientCredentialsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOAuthClientCredentialsRequest) String ¶

func (request ListOAuthClientCredentialsRequest) String() string

func (ListOAuthClientCredentialsRequest) ValidateEnumValue ¶

func (request ListOAuthClientCredentialsRequest) 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

type ListOAuthClientCredentialsResponse ¶

type ListOAuthClientCredentialsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []OAuth2ClientCredentialSummary instances
	Items []OAuth2ClientCredentialSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListOAuthClientCredentialsResponse wrapper for the ListOAuthClientCredentials operation

func (ListOAuthClientCredentialsResponse) HTTPResponse ¶

func (response ListOAuthClientCredentialsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOAuthClientCredentialsResponse) String ¶

func (response ListOAuthClientCredentialsResponse) String() string

type ListPoliciesRequest ¶

type ListPoliciesRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListPoliciesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListPoliciesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState PolicyLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListPoliciesRequest wrapper for the ListPolicies operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListPolicies.go.html to see an example of how to use ListPoliciesRequest.

func (ListPoliciesRequest) BinaryRequestBody ¶

func (request ListPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListPoliciesRequest) HTTPRequest ¶

func (request ListPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPoliciesRequest) RetryPolicy ¶

func (request ListPoliciesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPoliciesRequest) String ¶

func (request ListPoliciesRequest) String() string

func (ListPoliciesRequest) ValidateEnumValue ¶

func (request ListPoliciesRequest) 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

type ListPoliciesResponse ¶

type ListPoliciesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Policy instances
	Items []Policy `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListPoliciesResponse wrapper for the ListPolicies operation

func (ListPoliciesResponse) HTTPResponse ¶

func (response ListPoliciesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPoliciesResponse) String ¶

func (response ListPoliciesResponse) String() string

type ListPoliciesSortByEnum ¶

type ListPoliciesSortByEnum string

ListPoliciesSortByEnum Enum with underlying type: string

const (
	ListPoliciesSortByTimecreated ListPoliciesSortByEnum = "TIMECREATED"
	ListPoliciesSortByName        ListPoliciesSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListPoliciesSortByEnum

func GetListPoliciesSortByEnumValues ¶

func GetListPoliciesSortByEnumValues() []ListPoliciesSortByEnum

GetListPoliciesSortByEnumValues Enumerates the set of values for ListPoliciesSortByEnum

func GetMappingListPoliciesSortByEnum ¶

func GetMappingListPoliciesSortByEnum(val string) (ListPoliciesSortByEnum, bool)

GetMappingListPoliciesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListPoliciesSortOrderEnum ¶

type ListPoliciesSortOrderEnum string

ListPoliciesSortOrderEnum Enum with underlying type: string

const (
	ListPoliciesSortOrderAsc  ListPoliciesSortOrderEnum = "ASC"
	ListPoliciesSortOrderDesc ListPoliciesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListPoliciesSortOrderEnum

func GetListPoliciesSortOrderEnumValues ¶

func GetListPoliciesSortOrderEnumValues() []ListPoliciesSortOrderEnum

GetListPoliciesSortOrderEnumValues Enumerates the set of values for ListPoliciesSortOrderEnum

func GetMappingListPoliciesSortOrderEnum ¶

func GetMappingListPoliciesSortOrderEnum(val string) (ListPoliciesSortOrderEnum, bool)

GetMappingListPoliciesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListRegionSubscriptionsRequest ¶

type ListRegionSubscriptionsRequest struct {

	// The OCID of the tenancy.
	TenancyId *string `mandatory:"true" contributesTo:"path" name:"tenancyId"`

	// 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
}

ListRegionSubscriptionsRequest wrapper for the ListRegionSubscriptions operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListRegionSubscriptions.go.html to see an example of how to use ListRegionSubscriptionsRequest.

func (ListRegionSubscriptionsRequest) BinaryRequestBody ¶

func (request ListRegionSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListRegionSubscriptionsRequest) HTTPRequest ¶

func (request ListRegionSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRegionSubscriptionsRequest) RetryPolicy ¶

func (request ListRegionSubscriptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRegionSubscriptionsRequest) String ¶

func (request ListRegionSubscriptionsRequest) String() string

func (ListRegionSubscriptionsRequest) ValidateEnumValue ¶

func (request ListRegionSubscriptionsRequest) 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

type ListRegionSubscriptionsResponse ¶

type ListRegionSubscriptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []RegionSubscription instance
	Items []RegionSubscription `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"`
}

ListRegionSubscriptionsResponse wrapper for the ListRegionSubscriptions operation

func (ListRegionSubscriptionsResponse) HTTPResponse ¶

func (response ListRegionSubscriptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRegionSubscriptionsResponse) String ¶

func (response ListRegionSubscriptionsResponse) String() string

type ListRegionsRequest ¶

type ListRegionsRequest struct {

	// 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
}

ListRegionsRequest wrapper for the ListRegions operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListRegions.go.html to see an example of how to use ListRegionsRequest.

func (ListRegionsRequest) BinaryRequestBody ¶

func (request ListRegionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListRegionsRequest) HTTPRequest ¶

func (request ListRegionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRegionsRequest) RetryPolicy ¶

func (request ListRegionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRegionsRequest) String ¶

func (request ListRegionsRequest) String() string

func (ListRegionsRequest) ValidateEnumValue ¶

func (request ListRegionsRequest) 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

type ListRegionsResponse ¶

type ListRegionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []Region instance
	Items []Region `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"`
}

ListRegionsResponse wrapper for the ListRegions operation

func (ListRegionsResponse) HTTPResponse ¶

func (response ListRegionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRegionsResponse) String ¶

func (response ListRegionsResponse) String() string

type ListSmtpCredentialsRequest ¶

type ListSmtpCredentialsRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

ListSmtpCredentialsRequest wrapper for the ListSmtpCredentials operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListSmtpCredentials.go.html to see an example of how to use ListSmtpCredentialsRequest.

func (ListSmtpCredentialsRequest) BinaryRequestBody ¶

func (request ListSmtpCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSmtpCredentialsRequest) HTTPRequest ¶

func (request ListSmtpCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSmtpCredentialsRequest) RetryPolicy ¶

func (request ListSmtpCredentialsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSmtpCredentialsRequest) String ¶

func (request ListSmtpCredentialsRequest) String() string

func (ListSmtpCredentialsRequest) ValidateEnumValue ¶

func (request ListSmtpCredentialsRequest) 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

type ListSmtpCredentialsResponse ¶

type ListSmtpCredentialsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []SmtpCredentialSummary instance
	Items []SmtpCredentialSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListSmtpCredentialsResponse wrapper for the ListSmtpCredentials operation

func (ListSmtpCredentialsResponse) HTTPResponse ¶

func (response ListSmtpCredentialsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSmtpCredentialsResponse) String ¶

func (response ListSmtpCredentialsResponse) String() string

type ListStandardTagNamespacesRequest ¶

type ListStandardTagNamespacesRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListStandardTagNamespacesRequest wrapper for the ListStandardTagNamespaces operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListStandardTagNamespaces.go.html to see an example of how to use ListStandardTagNamespacesRequest.

func (ListStandardTagNamespacesRequest) BinaryRequestBody ¶

func (request ListStandardTagNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListStandardTagNamespacesRequest) HTTPRequest ¶

func (request ListStandardTagNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListStandardTagNamespacesRequest) RetryPolicy ¶

func (request ListStandardTagNamespacesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListStandardTagNamespacesRequest) String ¶

func (request ListStandardTagNamespacesRequest) String() string

func (ListStandardTagNamespacesRequest) ValidateEnumValue ¶

func (request ListStandardTagNamespacesRequest) 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

type ListStandardTagNamespacesResponse ¶

type ListStandardTagNamespacesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []StandardTagNamespaceTemplateSummary instances
	Items []StandardTagNamespaceTemplateSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListStandardTagNamespacesResponse wrapper for the ListStandardTagNamespaces operation

func (ListStandardTagNamespacesResponse) HTTPResponse ¶

func (response ListStandardTagNamespacesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListStandardTagNamespacesResponse) String ¶

func (response ListStandardTagNamespacesResponse) String() string

type ListSwiftPasswordsRequest ¶

type ListSwiftPasswordsRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// 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
}

ListSwiftPasswordsRequest wrapper for the ListSwiftPasswords operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListSwiftPasswords.go.html to see an example of how to use ListSwiftPasswordsRequest.

func (ListSwiftPasswordsRequest) BinaryRequestBody ¶

func (request ListSwiftPasswordsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSwiftPasswordsRequest) HTTPRequest ¶

func (request ListSwiftPasswordsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSwiftPasswordsRequest) RetryPolicy ¶

func (request ListSwiftPasswordsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSwiftPasswordsRequest) String ¶

func (request ListSwiftPasswordsRequest) String() string

func (ListSwiftPasswordsRequest) ValidateEnumValue ¶

func (request ListSwiftPasswordsRequest) 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

type ListSwiftPasswordsResponse ¶

type ListSwiftPasswordsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []SwiftPassword instance
	Items []SwiftPassword `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListSwiftPasswordsResponse wrapper for the ListSwiftPasswords operation

func (ListSwiftPasswordsResponse) HTTPResponse ¶

func (response ListSwiftPasswordsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSwiftPasswordsResponse) String ¶

func (response ListSwiftPasswordsResponse) String() string

type ListTagDefaultsRequest ¶

type ListTagDefaultsRequest struct {

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the specified OCID exactly.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The OCID of the tag definition.
	TagDefinitionId *string `mandatory:"false" contributesTo:"query" name:"tagDefinitionId"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState TagDefaultSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListTagDefaultsRequest wrapper for the ListTagDefaults operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTagDefaults.go.html to see an example of how to use ListTagDefaultsRequest.

func (ListTagDefaultsRequest) BinaryRequestBody ¶

func (request ListTagDefaultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTagDefaultsRequest) HTTPRequest ¶

func (request ListTagDefaultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTagDefaultsRequest) RetryPolicy ¶

func (request ListTagDefaultsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTagDefaultsRequest) String ¶

func (request ListTagDefaultsRequest) String() string

func (ListTagDefaultsRequest) ValidateEnumValue ¶

func (request ListTagDefaultsRequest) 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

type ListTagDefaultsResponse ¶

type ListTagDefaultsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TagDefaultSummary instances
	Items []TagDefaultSummary `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"`

	// For pagination of a list of tag default values. When paging through a list, if this header appears in
	// the response, then a partial list might have been returned. Include this value as the `page` parameter
	// for the subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListTagDefaultsResponse wrapper for the ListTagDefaults operation

func (ListTagDefaultsResponse) HTTPResponse ¶

func (response ListTagDefaultsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTagDefaultsResponse) String ¶

func (response ListTagDefaultsResponse) String() string

type ListTagNamespacesRequest ¶

type ListTagNamespacesRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this
	// parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
	IncludeSubcompartments *bool `mandatory:"false" contributesTo:"query" name:"includeSubcompartments"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState TagNamespaceLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListTagNamespacesRequest wrapper for the ListTagNamespaces operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTagNamespaces.go.html to see an example of how to use ListTagNamespacesRequest.

func (ListTagNamespacesRequest) BinaryRequestBody ¶

func (request ListTagNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTagNamespacesRequest) HTTPRequest ¶

func (request ListTagNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTagNamespacesRequest) RetryPolicy ¶

func (request ListTagNamespacesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTagNamespacesRequest) String ¶

func (request ListTagNamespacesRequest) String() string

func (ListTagNamespacesRequest) ValidateEnumValue ¶

func (request ListTagNamespacesRequest) 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

type ListTagNamespacesResponse ¶

type ListTagNamespacesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TagNamespaceSummary instances
	Items []TagNamespaceSummary `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"`

	// For pagination of a list of tagNamespaces. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListTagNamespacesResponse wrapper for the ListTagNamespaces operation

func (ListTagNamespacesResponse) HTTPResponse ¶

func (response ListTagNamespacesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTagNamespacesResponse) String ¶

func (response ListTagNamespacesResponse) String() string

type ListTaggingWorkRequestErrorsRequest ¶

type ListTaggingWorkRequestErrorsRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListTaggingWorkRequestErrorsRequest wrapper for the ListTaggingWorkRequestErrors operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequestErrors.go.html to see an example of how to use ListTaggingWorkRequestErrorsRequest.

func (ListTaggingWorkRequestErrorsRequest) BinaryRequestBody ¶

func (request ListTaggingWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTaggingWorkRequestErrorsRequest) HTTPRequest ¶

func (request ListTaggingWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTaggingWorkRequestErrorsRequest) RetryPolicy ¶

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTaggingWorkRequestErrorsRequest) String ¶

func (ListTaggingWorkRequestErrorsRequest) ValidateEnumValue ¶

func (request ListTaggingWorkRequestErrorsRequest) 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

type ListTaggingWorkRequestErrorsResponse ¶

type ListTaggingWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TaggingWorkRequestErrorSummary instances
	Items []TaggingWorkRequestErrorSummary `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"`

	// The number of seconds that the client should wait before polling again.
	RetryAfter *float32 `presentIn:"header" name:"retry-after"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListTaggingWorkRequestErrorsResponse wrapper for the ListTaggingWorkRequestErrors operation

func (ListTaggingWorkRequestErrorsResponse) HTTPResponse ¶

func (response ListTaggingWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTaggingWorkRequestErrorsResponse) String ¶

func (response ListTaggingWorkRequestErrorsResponse) String() string

type ListTaggingWorkRequestLogsRequest ¶

type ListTaggingWorkRequestLogsRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListTaggingWorkRequestLogsRequest wrapper for the ListTaggingWorkRequestLogs operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequestLogs.go.html to see an example of how to use ListTaggingWorkRequestLogsRequest.

func (ListTaggingWorkRequestLogsRequest) BinaryRequestBody ¶

func (request ListTaggingWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTaggingWorkRequestLogsRequest) HTTPRequest ¶

func (request ListTaggingWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTaggingWorkRequestLogsRequest) RetryPolicy ¶

func (request ListTaggingWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTaggingWorkRequestLogsRequest) String ¶

func (request ListTaggingWorkRequestLogsRequest) String() string

func (ListTaggingWorkRequestLogsRequest) ValidateEnumValue ¶

func (request ListTaggingWorkRequestLogsRequest) 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

type ListTaggingWorkRequestLogsResponse ¶

type ListTaggingWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TaggingWorkRequestLogSummary instances
	Items []TaggingWorkRequestLogSummary `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"`

	// The number of seconds that the client should wait before polling again.
	RetryAfter *float32 `presentIn:"header" name:"retry-after"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListTaggingWorkRequestLogsResponse wrapper for the ListTaggingWorkRequestLogs operation

func (ListTaggingWorkRequestLogsResponse) HTTPResponse ¶

func (response ListTaggingWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTaggingWorkRequestLogsResponse) String ¶

func (response ListTaggingWorkRequestLogsResponse) String() string

type ListTaggingWorkRequestsRequest ¶

type ListTaggingWorkRequestsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The identifier of the resource the work request affects.
	ResourceIdentifier *string `mandatory:"false" contributesTo:"query" name:"resourceIdentifier"`

	// 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
}

ListTaggingWorkRequestsRequest wrapper for the ListTaggingWorkRequests operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequests.go.html to see an example of how to use ListTaggingWorkRequestsRequest.

func (ListTaggingWorkRequestsRequest) BinaryRequestBody ¶

func (request ListTaggingWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTaggingWorkRequestsRequest) HTTPRequest ¶

func (request ListTaggingWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTaggingWorkRequestsRequest) RetryPolicy ¶

func (request ListTaggingWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTaggingWorkRequestsRequest) String ¶

func (request ListTaggingWorkRequestsRequest) String() string

func (ListTaggingWorkRequestsRequest) ValidateEnumValue ¶

func (request ListTaggingWorkRequestsRequest) 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

type ListTaggingWorkRequestsResponse ¶

type ListTaggingWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TaggingWorkRequestSummary instances
	Items []TaggingWorkRequestSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListTaggingWorkRequestsResponse wrapper for the ListTaggingWorkRequests operation

func (ListTaggingWorkRequestsResponse) HTTPResponse ¶

func (response ListTaggingWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTaggingWorkRequestsResponse) String ¶

func (response ListTaggingWorkRequestsResponse) String() string

type ListTagsRequest ¶

type ListTagsRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState TagLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListTagsRequest wrapper for the ListTags operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTags.go.html to see an example of how to use ListTagsRequest.

func (ListTagsRequest) BinaryRequestBody ¶

func (request ListTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTagsRequest) HTTPRequest ¶

func (request ListTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTagsRequest) RetryPolicy ¶

func (request ListTagsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTagsRequest) String ¶

func (request ListTagsRequest) String() string

func (ListTagsRequest) ValidateEnumValue ¶

func (request ListTagsRequest) 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

type ListTagsResponse ¶

type ListTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TagSummary instances
	Items []TagSummary `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"`

	// For pagination of a list of tags. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListTagsResponse wrapper for the ListTags operation

func (ListTagsResponse) HTTPResponse ¶

func (response ListTagsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTagsResponse) String ¶

func (response ListTagsResponse) String() string

type ListUserGroupMembershipsRequest ¶

type ListUserGroupMembershipsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the user.
	UserId *string `mandatory:"false" contributesTo:"query" name:"userId"`

	// The OCID of the group.
	GroupId *string `mandatory:"false" contributesTo:"query" name:"groupId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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
}

ListUserGroupMembershipsRequest wrapper for the ListUserGroupMemberships operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListUserGroupMemberships.go.html to see an example of how to use ListUserGroupMembershipsRequest.

func (ListUserGroupMembershipsRequest) BinaryRequestBody ¶

func (request ListUserGroupMembershipsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListUserGroupMembershipsRequest) HTTPRequest ¶

func (request ListUserGroupMembershipsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListUserGroupMembershipsRequest) RetryPolicy ¶

func (request ListUserGroupMembershipsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListUserGroupMembershipsRequest) String ¶

func (request ListUserGroupMembershipsRequest) String() string

func (ListUserGroupMembershipsRequest) ValidateEnumValue ¶

func (request ListUserGroupMembershipsRequest) 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

type ListUserGroupMembershipsResponse ¶

type ListUserGroupMembershipsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []UserGroupMembership instances
	Items []UserGroupMembership `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListUserGroupMembershipsResponse wrapper for the ListUserGroupMemberships operation

func (ListUserGroupMembershipsResponse) HTTPResponse ¶

func (response ListUserGroupMembershipsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListUserGroupMembershipsResponse) String ¶

func (response ListUserGroupMembershipsResponse) String() string

type ListUsersRequest ¶

type ListUsersRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The id of the identity provider.
	IdentityProviderId *string `mandatory:"false" contributesTo:"query" name:"identityProviderId"`

	// The id of a user in the identity provider.
	ExternalIdentifier *string `mandatory:"false" contributesTo:"query" name:"externalIdentifier"`

	// A filter to only return resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for NAME is ascending. The NAME
	// sort order is case sensitive.
	// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
	// optionally filter by Availability Domain if the scope of the resource type is within a
	// single Availability Domain. If you call one of these "List" operations without specifying
	// an Availability Domain, the resources are grouped by Availability Domain, then sorted.
	SortBy ListUsersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order
	// is case sensitive.
	SortOrder ListUsersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState UserLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListUsersRequest wrapper for the ListUsers operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListUsers.go.html to see an example of how to use ListUsersRequest.

func (ListUsersRequest) BinaryRequestBody ¶

func (request ListUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListUsersRequest) HTTPRequest ¶

func (request ListUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListUsersRequest) RetryPolicy ¶

func (request ListUsersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListUsersRequest) String ¶

func (request ListUsersRequest) String() string

func (ListUsersRequest) ValidateEnumValue ¶

func (request ListUsersRequest) 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

type ListUsersResponse ¶

type ListUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []User instances
	Items []User `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListUsersResponse wrapper for the ListUsers operation

func (ListUsersResponse) HTTPResponse ¶

func (response ListUsersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListUsersResponse) String ¶

func (response ListUsersResponse) String() string

type ListUsersSortByEnum ¶

type ListUsersSortByEnum string

ListUsersSortByEnum Enum with underlying type: string

const (
	ListUsersSortByTimecreated ListUsersSortByEnum = "TIMECREATED"
	ListUsersSortByName        ListUsersSortByEnum = "NAME"
)

Set of constants representing the allowable values for ListUsersSortByEnum

func GetListUsersSortByEnumValues ¶

func GetListUsersSortByEnumValues() []ListUsersSortByEnum

GetListUsersSortByEnumValues Enumerates the set of values for ListUsersSortByEnum

func GetMappingListUsersSortByEnum ¶

func GetMappingListUsersSortByEnum(val string) (ListUsersSortByEnum, bool)

GetMappingListUsersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListUsersSortOrderEnum ¶

type ListUsersSortOrderEnum string

ListUsersSortOrderEnum Enum with underlying type: string

const (
	ListUsersSortOrderAsc  ListUsersSortOrderEnum = "ASC"
	ListUsersSortOrderDesc ListUsersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListUsersSortOrderEnum

func GetListUsersSortOrderEnumValues ¶

func GetListUsersSortOrderEnumValues() []ListUsersSortOrderEnum

GetListUsersSortOrderEnumValues Enumerates the set of values for ListUsersSortOrderEnum

func GetMappingListUsersSortOrderEnum ¶

func GetMappingListUsersSortOrderEnum(val string) (ListUsersSortOrderEnum, bool)

GetMappingListUsersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsRequest ¶

type ListWorkRequestsRequest struct {

	// The OCID of the compartment (remember that the tenancy is simply the root compartment).
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The identifier of the resource the work request affects.
	ResourceIdentifier *string `mandatory:"false" contributesTo:"query" name:"resourceIdentifier"`

	// 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody ¶

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest ¶

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy ¶

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String ¶

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue ¶

func (request ListWorkRequestsRequest) 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

type ListWorkRequestsResponse ¶

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestSummary instances
	Items []WorkRequestSummary `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"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse ¶

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String ¶

func (response ListWorkRequestsResponse) String() string

type MfaTotpDevice ¶

type MfaTotpDevice struct {

	// The OCID of the MFA TOTP device.
	Id *string `mandatory:"true" json:"id"`

	// The seed for the MFA TOTP device (Base32 encoded).
	Seed *string `mandatory:"true" json:"seed"`

	// The OCID of the user the MFA TOTP device belongs to.
	UserId *string `mandatory:"true" json:"userId"`

	// Date and time the `MfaTotpDevice` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The MFA TOTP device's current state. After creating the MFA TOTP device, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState MfaTotpDeviceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Flag to indicate if the MFA TOTP device has been activated.
	IsActivated *bool `mandatory:"true" json:"isActivated"`

	// Date and time when this MFA TOTP device will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The detailed status of INACTIVE lifecycleState.
	// Allowed values are:
	//  - 1 - SUSPENDED
	//  - 2 - DISABLED
	//  - 4 - BLOCKED
	//  - 8 - LOCKED
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

MfaTotpDevice Users can enable multi-factor authentication (MFA) for their own user accounts. After MFA is enabled, the user is prompted for a time-based one-time password (TOTP) to authenticate before they can sign in to the Console. To enable multi-factor authentication, the user must register a mobile device with a TOTP authenticator app installed. The registration process creates the `MfaTotpDevice` object. The registration process requires interaction with the Console and cannot be completed programmatically. For more information, see Managing Multi-Factor Authentication (https://docs.cloud.oracle.com/Content/Identity/mfa/understand-multi-factor-authentication.htm).

func (MfaTotpDevice) String ¶

func (m MfaTotpDevice) String() string

func (MfaTotpDevice) ValidateEnumValue ¶

func (m MfaTotpDevice) 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

type MfaTotpDeviceLifecycleStateEnum ¶

type MfaTotpDeviceLifecycleStateEnum string

MfaTotpDeviceLifecycleStateEnum Enum with underlying type: string

const (
	MfaTotpDeviceLifecycleStateCreating MfaTotpDeviceLifecycleStateEnum = "CREATING"
	MfaTotpDeviceLifecycleStateActive   MfaTotpDeviceLifecycleStateEnum = "ACTIVE"
	MfaTotpDeviceLifecycleStateInactive MfaTotpDeviceLifecycleStateEnum = "INACTIVE"
	MfaTotpDeviceLifecycleStateDeleting MfaTotpDeviceLifecycleStateEnum = "DELETING"
	MfaTotpDeviceLifecycleStateDeleted  MfaTotpDeviceLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for MfaTotpDeviceLifecycleStateEnum

func GetMappingMfaTotpDeviceLifecycleStateEnum ¶

func GetMappingMfaTotpDeviceLifecycleStateEnum(val string) (MfaTotpDeviceLifecycleStateEnum, bool)

GetMappingMfaTotpDeviceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetMfaTotpDeviceLifecycleStateEnumValues ¶

func GetMfaTotpDeviceLifecycleStateEnumValues() []MfaTotpDeviceLifecycleStateEnum

GetMfaTotpDeviceLifecycleStateEnumValues Enumerates the set of values for MfaTotpDeviceLifecycleStateEnum

type MfaTotpDeviceSummary ¶

type MfaTotpDeviceSummary struct {

	// The OCID of the MFA TOTP Device.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the user the MFA TOTP device belongs to.
	UserId *string `mandatory:"true" json:"userId"`

	// Date and time the `MfaTotpDevice` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The MFA TOTP device's current state.
	LifecycleState MfaTotpDeviceSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Flag to indicate if the MFA TOTP device has been activated
	IsActivated *bool `mandatory:"true" json:"isActivated"`

	// Date and time when this MFA TOTP device will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The detailed status of INACTIVE lifecycleState.
	// Allowed values are:
	//  - 1 - SUSPENDED
	//  - 2 - DISABLED
	//  - 4 - BLOCKED
	//  - 8 - LOCKED
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

MfaTotpDeviceSummary As the name suggests, a `MfaTotpDeviceSummary` object contains information about a `MfaTotpDevice`.

func (MfaTotpDeviceSummary) String ¶

func (m MfaTotpDeviceSummary) String() string

func (MfaTotpDeviceSummary) ValidateEnumValue ¶

func (m MfaTotpDeviceSummary) 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

type MfaTotpDeviceSummaryLifecycleStateEnum ¶

type MfaTotpDeviceSummaryLifecycleStateEnum string

MfaTotpDeviceSummaryLifecycleStateEnum Enum with underlying type: string

const (
	MfaTotpDeviceSummaryLifecycleStateCreating MfaTotpDeviceSummaryLifecycleStateEnum = "CREATING"
	MfaTotpDeviceSummaryLifecycleStateActive   MfaTotpDeviceSummaryLifecycleStateEnum = "ACTIVE"
	MfaTotpDeviceSummaryLifecycleStateInactive MfaTotpDeviceSummaryLifecycleStateEnum = "INACTIVE"
	MfaTotpDeviceSummaryLifecycleStateDeleting MfaTotpDeviceSummaryLifecycleStateEnum = "DELETING"
	MfaTotpDeviceSummaryLifecycleStateDeleted  MfaTotpDeviceSummaryLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for MfaTotpDeviceSummaryLifecycleStateEnum

func GetMappingMfaTotpDeviceSummaryLifecycleStateEnum ¶

func GetMappingMfaTotpDeviceSummaryLifecycleStateEnum(val string) (MfaTotpDeviceSummaryLifecycleStateEnum, bool)

GetMappingMfaTotpDeviceSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetMfaTotpDeviceSummaryLifecycleStateEnumValues ¶

func GetMfaTotpDeviceSummaryLifecycleStateEnumValues() []MfaTotpDeviceSummaryLifecycleStateEnum

GetMfaTotpDeviceSummaryLifecycleStateEnumValues Enumerates the set of values for MfaTotpDeviceSummaryLifecycleStateEnum

type MfaTotpToken ¶

type MfaTotpToken struct {

	// The Totp token for MFA.
	TotpToken *string `mandatory:"false" json:"totpToken"`
}

MfaTotpToken Totp token for MFA

func (MfaTotpToken) String ¶

func (m MfaTotpToken) String() string

func (MfaTotpToken) ValidateEnumValue ¶

func (m MfaTotpToken) 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

type MoveCompartmentDetails ¶

type MoveCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the destination compartment
	// into which to move the compartment.
	TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`
}

MoveCompartmentDetails The representation of MoveCompartmentDetails

func (MoveCompartmentDetails) String ¶

func (m MoveCompartmentDetails) String() string

func (MoveCompartmentDetails) ValidateEnumValue ¶

func (m MoveCompartmentDetails) 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

type MoveCompartmentRequest ¶

type MoveCompartmentRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// Request object for moving a compartment.
	MoveCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

MoveCompartmentRequest wrapper for the MoveCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/MoveCompartment.go.html to see an example of how to use MoveCompartmentRequest.

func (MoveCompartmentRequest) BinaryRequestBody ¶

func (request MoveCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (MoveCompartmentRequest) HTTPRequest ¶

func (request MoveCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (MoveCompartmentRequest) RetryPolicy ¶

func (request MoveCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (MoveCompartmentRequest) String ¶

func (request MoveCompartmentRequest) String() string

func (MoveCompartmentRequest) ValidateEnumValue ¶

func (request MoveCompartmentRequest) 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

type MoveCompartmentResponse ¶

type MoveCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

MoveCompartmentResponse wrapper for the MoveCompartment operation

func (MoveCompartmentResponse) HTTPResponse ¶

func (response MoveCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (MoveCompartmentResponse) String ¶

func (response MoveCompartmentResponse) String() string

type NetworkPolicy ¶

type NetworkPolicy struct {

	// Network Source ids
	NetworkSourceIds []string `mandatory:"false" json:"networkSourceIds"`
}

NetworkPolicy Network policy, which consists of a list of network source IDs.

func (NetworkPolicy) String ¶

func (m NetworkPolicy) String() string

func (NetworkPolicy) ValidateEnumValue ¶

func (m NetworkPolicy) 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

type NetworkSources ¶

type NetworkSources struct {

	// The OCID of the network source.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the network source. The tenancy is the root compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the network source during creation. The name must be unique across
	// the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the network source. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// Date and time the network source was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The network source object's current state. After creating a network source, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState NetworkSourcesLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// A list of allowed public IPs and CIDR ranges.
	PublicSourceList []string `mandatory:"false" json:"publicSourceList"`

	// A list of allowed VCN OCID and IP range pairs.
	// Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]`
	VirtualSourceList []NetworkSourcesVirtualSourceList `mandatory:"false" json:"virtualSourceList"`

	// -- The services attribute has no effect and is reserved for use by Oracle. --
	Services []string `mandatory:"false" json:"services"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

NetworkSources A network source specifies a list of source IP addresses that are allowed to make authorization requests. Use the network source in policy statements to restrict access to only requests that come from the specified IPs. For more information, see Managing Network Sources (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).

func (NetworkSources) String ¶

func (m NetworkSources) String() string

func (NetworkSources) ValidateEnumValue ¶

func (m NetworkSources) 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

type NetworkSourcesLifecycleStateEnum ¶

type NetworkSourcesLifecycleStateEnum string

NetworkSourcesLifecycleStateEnum Enum with underlying type: string

const (
	NetworkSourcesLifecycleStateCreating NetworkSourcesLifecycleStateEnum = "CREATING"
	NetworkSourcesLifecycleStateActive   NetworkSourcesLifecycleStateEnum = "ACTIVE"
	NetworkSourcesLifecycleStateInactive NetworkSourcesLifecycleStateEnum = "INACTIVE"
	NetworkSourcesLifecycleStateDeleting NetworkSourcesLifecycleStateEnum = "DELETING"
	NetworkSourcesLifecycleStateDeleted  NetworkSourcesLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for NetworkSourcesLifecycleStateEnum

func GetMappingNetworkSourcesLifecycleStateEnum ¶

func GetMappingNetworkSourcesLifecycleStateEnum(val string) (NetworkSourcesLifecycleStateEnum, bool)

GetMappingNetworkSourcesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetNetworkSourcesLifecycleStateEnumValues ¶

func GetNetworkSourcesLifecycleStateEnumValues() []NetworkSourcesLifecycleStateEnum

GetNetworkSourcesLifecycleStateEnumValues Enumerates the set of values for NetworkSourcesLifecycleStateEnum

type NetworkSourcesSummary ¶

type NetworkSourcesSummary struct {

	// The OCID of the network source.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy (root compartment) containing the network source.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the network source during creation. The name must be unique across
	// the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the network source. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// The network source object's current state. After creating a network source, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState NetworkSourcesLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Date and time the network source was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// A list of allowed public IP addresses and CIDR ranges.
	PublicSourceList []string `mandatory:"false" json:"publicSourceList"`

	// A list of allowed VCN OCID and IP range pairs.
	// Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]`
	VirtualSourceList []NetworkSourcesVirtualSourceList `mandatory:"false" json:"virtualSourceList"`

	// -- The services attribute has no effect and is reserved for use by Oracle. --
	Services []string `mandatory:"false" json:"services"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

NetworkSourcesSummary A network source specifies a list of source IP addresses that are allowed to make authorization requests. Use the network source in policy statements to restrict access to only requests that come from the specified IPs. For more information, see Managing Network Sources (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).

func (NetworkSourcesSummary) String ¶

func (m NetworkSourcesSummary) String() string

func (NetworkSourcesSummary) ValidateEnumValue ¶

func (m NetworkSourcesSummary) 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

type NetworkSourcesVirtualSourceList ¶

type NetworkSourcesVirtualSourceList struct {
	VcnId *string `mandatory:"false" json:"vcnId"`

	IpRanges []string `mandatory:"false" json:"ipRanges"`
}

NetworkSourcesVirtualSourceList The representation of NetworkSourcesVirtualSourceList

func (NetworkSourcesVirtualSourceList) String ¶

func (NetworkSourcesVirtualSourceList) ValidateEnumValue ¶

func (m NetworkSourcesVirtualSourceList) 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

type OAuth2ClientCredential ¶

type OAuth2ClientCredential struct {

	// Allowed scopes for the given oauth credential.
	Scopes []FullyQualifiedScope `mandatory:"false" json:"scopes"`

	// Returned during create and update with password reset requests.
	Password *string `mandatory:"false" json:"password"`

	// The OCID of the user the Oauth credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	ExpiresOn *common.SDKTime `mandatory:"false" json:"expiresOn"`

	// The OCID of the Oauth credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the compartment containing the Oauth credential.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The name of the Oauth credential.
	Name *string `mandatory:"false" json:"name"`

	// The description of the Oauth credential.
	Description *string `mandatory:"false" json:"description"`

	// The credential's current state. After creating a Oauth credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState OAuth2ClientCredentialLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Date and time the `OAuth2ClientCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

OAuth2ClientCredential User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.

func (OAuth2ClientCredential) String ¶

func (m OAuth2ClientCredential) String() string

func (OAuth2ClientCredential) ValidateEnumValue ¶

func (m OAuth2ClientCredential) 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

type OAuth2ClientCredentialLifecycleStateEnum ¶

type OAuth2ClientCredentialLifecycleStateEnum string

OAuth2ClientCredentialLifecycleStateEnum Enum with underlying type: string

const (
	OAuth2ClientCredentialLifecycleStateCreating OAuth2ClientCredentialLifecycleStateEnum = "CREATING"
	OAuth2ClientCredentialLifecycleStateActive   OAuth2ClientCredentialLifecycleStateEnum = "ACTIVE"
	OAuth2ClientCredentialLifecycleStateInactive OAuth2ClientCredentialLifecycleStateEnum = "INACTIVE"
	OAuth2ClientCredentialLifecycleStateDeleting OAuth2ClientCredentialLifecycleStateEnum = "DELETING"
	OAuth2ClientCredentialLifecycleStateDeleted  OAuth2ClientCredentialLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for OAuth2ClientCredentialLifecycleStateEnum

func GetMappingOAuth2ClientCredentialLifecycleStateEnum ¶

func GetMappingOAuth2ClientCredentialLifecycleStateEnum(val string) (OAuth2ClientCredentialLifecycleStateEnum, bool)

GetMappingOAuth2ClientCredentialLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOAuth2ClientCredentialLifecycleStateEnumValues ¶

func GetOAuth2ClientCredentialLifecycleStateEnumValues() []OAuth2ClientCredentialLifecycleStateEnum

GetOAuth2ClientCredentialLifecycleStateEnumValues Enumerates the set of values for OAuth2ClientCredentialLifecycleStateEnum

type OAuth2ClientCredentialSummary ¶

type OAuth2ClientCredentialSummary struct {

	// Allowed scopes for the given oauth credential.
	Scopes []FullyQualifiedScope `mandatory:"false" json:"scopes"`

	// The OCID of the user the Oauth credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	ExpiresOn *common.SDKTime `mandatory:"false" json:"expiresOn"`

	// The OCID of the Oauth credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the compartment containing the Oauth credential.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The name of the Oauth credential.
	Name *string `mandatory:"false" json:"name"`

	// The description of the Oauth credential.
	Description *string `mandatory:"false" json:"description"`

	// The credential's current state. After creating a Oauth credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState OAuth2ClientCredentialSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Date and time the `OAuth2ClientCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

OAuth2ClientCredentialSummary User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.

func (OAuth2ClientCredentialSummary) String ¶

func (OAuth2ClientCredentialSummary) ValidateEnumValue ¶

func (m OAuth2ClientCredentialSummary) 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

type OAuth2ClientCredentialSummaryLifecycleStateEnum ¶

type OAuth2ClientCredentialSummaryLifecycleStateEnum string

OAuth2ClientCredentialSummaryLifecycleStateEnum Enum with underlying type: string

const (
	OAuth2ClientCredentialSummaryLifecycleStateCreating OAuth2ClientCredentialSummaryLifecycleStateEnum = "CREATING"
	OAuth2ClientCredentialSummaryLifecycleStateActive   OAuth2ClientCredentialSummaryLifecycleStateEnum = "ACTIVE"
	OAuth2ClientCredentialSummaryLifecycleStateInactive OAuth2ClientCredentialSummaryLifecycleStateEnum = "INACTIVE"
	OAuth2ClientCredentialSummaryLifecycleStateDeleting OAuth2ClientCredentialSummaryLifecycleStateEnum = "DELETING"
	OAuth2ClientCredentialSummaryLifecycleStateDeleted  OAuth2ClientCredentialSummaryLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for OAuth2ClientCredentialSummaryLifecycleStateEnum

func GetMappingOAuth2ClientCredentialSummaryLifecycleStateEnum ¶

func GetMappingOAuth2ClientCredentialSummaryLifecycleStateEnum(val string) (OAuth2ClientCredentialSummaryLifecycleStateEnum, bool)

GetMappingOAuth2ClientCredentialSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOAuth2ClientCredentialSummaryLifecycleStateEnumValues ¶

func GetOAuth2ClientCredentialSummaryLifecycleStateEnumValues() []OAuth2ClientCredentialSummaryLifecycleStateEnum

GetOAuth2ClientCredentialSummaryLifecycleStateEnumValues Enumerates the set of values for OAuth2ClientCredentialSummaryLifecycleStateEnum

type PasswordPolicy ¶

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

PasswordPolicy Password policy, currently set for the given compartment.

func (PasswordPolicy) String ¶

func (m PasswordPolicy) String() string

func (PasswordPolicy) ValidateEnumValue ¶

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

type Policy ¶

type Policy struct {

	// The OCID of the policy.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment containing the policy (either the tenancy or another compartment).
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the policy during creation. The name must be unique across all policies
	// in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// An array of one or more policy statements written in the policy language.
	Statements []string `mandatory:"true" json:"statements"`

	// The description you assign to the policy. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// Date and time the policy was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The policy's current state. After creating a policy, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState PolicyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// The version of the policy. If null or set to an empty string, when a request comes in for authorization, the
	// policy will be evaluated according to the current behavior of the services at that moment. If set to a particular
	// date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.
	VersionDate *common.SDKDate `mandatory:"false" json:"versionDate"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Policy A document that specifies the type of access a group has to the resources in a compartment. For information about policies and other IAM Service components, see Overview of IAM (https://docs.cloud.oracle.com/Content/Identity/getstarted/identity-domains.htm). If you're new to policies, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm). The word "policy" is used by people in different ways:

  • An individual statement written in the policy language
  • A collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it)
  • The overall body of policies your organization uses to control access to resources

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Policy) String ¶

func (m Policy) String() string

func (Policy) ValidateEnumValue ¶

func (m Policy) 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

type PolicyLifecycleStateEnum ¶

type PolicyLifecycleStateEnum string

PolicyLifecycleStateEnum Enum with underlying type: string

const (
	PolicyLifecycleStateCreating PolicyLifecycleStateEnum = "CREATING"
	PolicyLifecycleStateActive   PolicyLifecycleStateEnum = "ACTIVE"
	PolicyLifecycleStateInactive PolicyLifecycleStateEnum = "INACTIVE"
	PolicyLifecycleStateDeleting PolicyLifecycleStateEnum = "DELETING"
	PolicyLifecycleStateDeleted  PolicyLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for PolicyLifecycleStateEnum

func GetMappingPolicyLifecycleStateEnum ¶

func GetMappingPolicyLifecycleStateEnum(val string) (PolicyLifecycleStateEnum, bool)

GetMappingPolicyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPolicyLifecycleStateEnumValues ¶

func GetPolicyLifecycleStateEnumValues() []PolicyLifecycleStateEnum

GetPolicyLifecycleStateEnumValues Enumerates the set of values for PolicyLifecycleStateEnum

type RecoverCompartmentRequest ¶

type RecoverCompartmentRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

RecoverCompartmentRequest wrapper for the RecoverCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RecoverCompartment.go.html to see an example of how to use RecoverCompartmentRequest.

func (RecoverCompartmentRequest) BinaryRequestBody ¶

func (request RecoverCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RecoverCompartmentRequest) HTTPRequest ¶

func (request RecoverCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RecoverCompartmentRequest) RetryPolicy ¶

func (request RecoverCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RecoverCompartmentRequest) String ¶

func (request RecoverCompartmentRequest) String() string

func (RecoverCompartmentRequest) ValidateEnumValue ¶

func (request RecoverCompartmentRequest) 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

type RecoverCompartmentResponse ¶

type RecoverCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Compartment instance
	Compartment `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

RecoverCompartmentResponse wrapper for the RecoverCompartment operation

func (RecoverCompartmentResponse) HTTPResponse ¶

func (response RecoverCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RecoverCompartmentResponse) String ¶

func (response RecoverCompartmentResponse) String() string

type Region ¶

type Region struct {

	// The key of the region. See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm) for
	// the full list of supported 3-letter region codes.
	// Example: `PHX`
	Key *string `mandatory:"false" json:"key"`

	// The name of the region. See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported region names.
	// Example: `us-phoenix-1`
	Name *string `mandatory:"false" json:"name"`
}

Region A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability Domains. A region is composed of several Availability Domains. An Availability Domain is one or more data centers located within a region. For more information, see Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm).

func (Region) String ¶

func (m Region) String() string

func (Region) ValidateEnumValue ¶

func (m Region) 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

type RegionSubscription ¶

type RegionSubscription struct {

	// The region's key. See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported 3-letter region codes.
	// Example: `PHX`
	RegionKey *string `mandatory:"true" json:"regionKey"`

	// The region's name. See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported region names.
	// Example: `us-phoenix-1`
	RegionName *string `mandatory:"true" json:"regionName"`

	// The region subscription status.
	Status RegionSubscriptionStatusEnum `mandatory:"true" json:"status"`

	// Indicates if the region is the home region or not.
	IsHomeRegion *bool `mandatory:"true" json:"isHomeRegion"`
}

RegionSubscription An object that represents your tenancy's access to a particular region (i.e., a subscription), the status of that access, and whether that region is the home region. For more information, see Managing Regions (https://docs.cloud.oracle.com/Content/Identity/regions/managingregions.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm).

func (RegionSubscription) String ¶

func (m RegionSubscription) String() string

func (RegionSubscription) ValidateEnumValue ¶

func (m RegionSubscription) 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

type RegionSubscriptionStatusEnum ¶

type RegionSubscriptionStatusEnum string

RegionSubscriptionStatusEnum Enum with underlying type: string

const (
	RegionSubscriptionStatusReady      RegionSubscriptionStatusEnum = "READY"
	RegionSubscriptionStatusInProgress RegionSubscriptionStatusEnum = "IN_PROGRESS"
)

Set of constants representing the allowable values for RegionSubscriptionStatusEnum

func GetMappingRegionSubscriptionStatusEnum ¶

func GetMappingRegionSubscriptionStatusEnum(val string) (RegionSubscriptionStatusEnum, bool)

GetMappingRegionSubscriptionStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRegionSubscriptionStatusEnumValues ¶

func GetRegionSubscriptionStatusEnumValues() []RegionSubscriptionStatusEnum

GetRegionSubscriptionStatusEnumValues Enumerates the set of values for RegionSubscriptionStatusEnum

type RemoveLockDetails ¶ added in v65.9.0

type RemoveLockDetails struct {

	// Type of the lock.
	Type RemoveLockDetailsTypeEnum `mandatory:"true" json:"type"`
}

RemoveLockDetails Request payload to remove lock to the resource.

func (RemoveLockDetails) String ¶ added in v65.9.0

func (m RemoveLockDetails) String() string

func (RemoveLockDetails) ValidateEnumValue ¶ added in v65.9.0

func (m RemoveLockDetails) 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

type RemoveLockDetailsTypeEnum ¶ added in v65.9.0

type RemoveLockDetailsTypeEnum string

RemoveLockDetailsTypeEnum Enum with underlying type: string

const (
	RemoveLockDetailsTypeFull   RemoveLockDetailsTypeEnum = "FULL"
	RemoveLockDetailsTypeDelete RemoveLockDetailsTypeEnum = "DELETE"
)

Set of constants representing the allowable values for RemoveLockDetailsTypeEnum

func GetMappingRemoveLockDetailsTypeEnum ¶ added in v65.9.0

func GetMappingRemoveLockDetailsTypeEnum(val string) (RemoveLockDetailsTypeEnum, bool)

GetMappingRemoveLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRemoveLockDetailsTypeEnumValues ¶ added in v65.9.0

func GetRemoveLockDetailsTypeEnumValues() []RemoveLockDetailsTypeEnum

GetRemoveLockDetailsTypeEnumValues Enumerates the set of values for RemoveLockDetailsTypeEnum

type RemoveTagDefaultLockRequest ¶ added in v65.9.0

type RemoveTagDefaultLockRequest struct {

	// The OCID of the tag default.
	TagDefaultId *string `mandatory:"true" contributesTo:"path" name:"tagDefaultId"`

	// Lock that is going to be removed from resource
	RemoveLockDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

RemoveTagDefaultLockRequest wrapper for the RemoveTagDefaultLock operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveTagDefaultLock.go.html to see an example of how to use RemoveTagDefaultLockRequest.

func (RemoveTagDefaultLockRequest) BinaryRequestBody ¶ added in v65.9.0

func (request RemoveTagDefaultLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RemoveTagDefaultLockRequest) HTTPRequest ¶ added in v65.9.0

func (request RemoveTagDefaultLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RemoveTagDefaultLockRequest) RetryPolicy ¶ added in v65.9.0

func (request RemoveTagDefaultLockRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RemoveTagDefaultLockRequest) String ¶ added in v65.9.0

func (request RemoveTagDefaultLockRequest) String() string

func (RemoveTagDefaultLockRequest) ValidateEnumValue ¶ added in v65.9.0

func (request RemoveTagDefaultLockRequest) 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

type RemoveTagDefaultLockResponse ¶ added in v65.9.0

type RemoveTagDefaultLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagDefault instance
	TagDefault `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

RemoveTagDefaultLockResponse wrapper for the RemoveTagDefaultLock operation

func (RemoveTagDefaultLockResponse) HTTPResponse ¶ added in v65.9.0

func (response RemoveTagDefaultLockResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RemoveTagDefaultLockResponse) String ¶ added in v65.9.0

func (response RemoveTagDefaultLockResponse) String() string

type RemoveTagNamespaceLockRequest ¶ added in v65.9.0

type RemoveTagNamespaceLockRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// Lock that is going to be removed from resource
	RemoveLockDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

RemoveTagNamespaceLockRequest wrapper for the RemoveTagNamespaceLock operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveTagNamespaceLock.go.html to see an example of how to use RemoveTagNamespaceLockRequest.

func (RemoveTagNamespaceLockRequest) BinaryRequestBody ¶ added in v65.9.0

func (request RemoveTagNamespaceLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RemoveTagNamespaceLockRequest) HTTPRequest ¶ added in v65.9.0

func (request RemoveTagNamespaceLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RemoveTagNamespaceLockRequest) RetryPolicy ¶ added in v65.9.0

func (request RemoveTagNamespaceLockRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RemoveTagNamespaceLockRequest) String ¶ added in v65.9.0

func (request RemoveTagNamespaceLockRequest) String() string

func (RemoveTagNamespaceLockRequest) ValidateEnumValue ¶ added in v65.9.0

func (request RemoveTagNamespaceLockRequest) 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

type RemoveTagNamespaceLockResponse ¶ added in v65.9.0

type RemoveTagNamespaceLockResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagNamespace instance
	TagNamespace `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

RemoveTagNamespaceLockResponse wrapper for the RemoveTagNamespaceLock operation

func (RemoveTagNamespaceLockResponse) HTTPResponse ¶ added in v65.9.0

func (response RemoveTagNamespaceLockResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RemoveTagNamespaceLockResponse) String ¶ added in v65.9.0

func (response RemoveTagNamespaceLockResponse) String() string

type RemoveUserFromGroupRequest ¶

type RemoveUserFromGroupRequest struct {

	// The OCID of the userGroupMembership.
	UserGroupMembershipId *string `mandatory:"true" contributesTo:"path" name:"userGroupMembershipId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

RemoveUserFromGroupRequest wrapper for the RemoveUserFromGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveUserFromGroup.go.html to see an example of how to use RemoveUserFromGroupRequest.

func (RemoveUserFromGroupRequest) BinaryRequestBody ¶

func (request RemoveUserFromGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RemoveUserFromGroupRequest) HTTPRequest ¶

func (request RemoveUserFromGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RemoveUserFromGroupRequest) RetryPolicy ¶

func (request RemoveUserFromGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RemoveUserFromGroupRequest) String ¶

func (request RemoveUserFromGroupRequest) String() string

func (RemoveUserFromGroupRequest) ValidateEnumValue ¶

func (request RemoveUserFromGroupRequest) 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

type RemoveUserFromGroupResponse ¶

type RemoveUserFromGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

RemoveUserFromGroupResponse wrapper for the RemoveUserFromGroup operation

func (RemoveUserFromGroupResponse) HTTPResponse ¶

func (response RemoveUserFromGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RemoveUserFromGroupResponse) String ¶

func (response RemoveUserFromGroupResponse) String() string

type ReplicatedRegionDetails ¶

type ReplicatedRegionDetails struct {

	// A REPLICATION_ENABLED region, e.g. us-ashburn-1.
	// See Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm)
	// for the full list of supported region names.
	Region *string `mandatory:"false" json:"region"`

	// Region-agnostic identity domain URL.
	Url *string `mandatory:"false" json:"url"`

	// Region-specific identity domain URL.
	RegionalUrl *string `mandatory:"false" json:"regionalUrl"`

	// The IDCS-replicated region state.
	State ReplicatedRegionDetailsStateEnum `mandatory:"false" json:"state,omitempty"`
}

ReplicatedRegionDetails (For tenancies that support identity domains) Properties for a region where a replica for the identity domain exists.

func (ReplicatedRegionDetails) String ¶

func (m ReplicatedRegionDetails) String() string

func (ReplicatedRegionDetails) ValidateEnumValue ¶

func (m ReplicatedRegionDetails) 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

type ReplicatedRegionDetailsStateEnum ¶

type ReplicatedRegionDetailsStateEnum string

ReplicatedRegionDetailsStateEnum Enum with underlying type: string

const (
	ReplicatedRegionDetailsStateEnablingReplication  ReplicatedRegionDetailsStateEnum = "ENABLING_REPLICATION"
	ReplicatedRegionDetailsStateReplicationEnabled   ReplicatedRegionDetailsStateEnum = "REPLICATION_ENABLED"
	ReplicatedRegionDetailsStateDisablingReplication ReplicatedRegionDetailsStateEnum = "DISABLING_REPLICATION"
	ReplicatedRegionDetailsStateReplicationDisabled  ReplicatedRegionDetailsStateEnum = "REPLICATION_DISABLED"
	ReplicatedRegionDetailsStateDeleted              ReplicatedRegionDetailsStateEnum = "DELETED"
)

Set of constants representing the allowable values for ReplicatedRegionDetailsStateEnum

func GetMappingReplicatedRegionDetailsStateEnum ¶

func GetMappingReplicatedRegionDetailsStateEnum(val string) (ReplicatedRegionDetailsStateEnum, bool)

GetMappingReplicatedRegionDetailsStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetReplicatedRegionDetailsStateEnumValues ¶

func GetReplicatedRegionDetailsStateEnumValues() []ReplicatedRegionDetailsStateEnum

GetReplicatedRegionDetailsStateEnumValues Enumerates the set of values for ReplicatedRegionDetailsStateEnum

type ResetIdpScimClientRequest ¶

type ResetIdpScimClientRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// 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
}

ResetIdpScimClientRequest wrapper for the ResetIdpScimClient operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ResetIdpScimClient.go.html to see an example of how to use ResetIdpScimClientRequest.

func (ResetIdpScimClientRequest) BinaryRequestBody ¶

func (request ResetIdpScimClientRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ResetIdpScimClientRequest) HTTPRequest ¶

func (request ResetIdpScimClientRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ResetIdpScimClientRequest) RetryPolicy ¶

func (request ResetIdpScimClientRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ResetIdpScimClientRequest) String ¶

func (request ResetIdpScimClientRequest) String() string

func (ResetIdpScimClientRequest) ValidateEnumValue ¶

func (request ResetIdpScimClientRequest) 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

type ResetIdpScimClientResponse ¶

type ResetIdpScimClientResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ScimClientCredentials instance
	ScimClientCredentials `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"`
}

ResetIdpScimClientResponse wrapper for the ResetIdpScimClient operation

func (ResetIdpScimClientResponse) HTTPResponse ¶

func (response ResetIdpScimClientResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ResetIdpScimClientResponse) String ¶

func (response ResetIdpScimClientResponse) String() string

type ResourceLock ¶ added in v65.9.0

type ResourceLock struct {

	// Type of the lock.
	Type ResourceLockTypeEnum `mandatory:"true" json:"type"`

	// The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
	RelatedResourceId *string `mandatory:"false" json:"relatedResourceId"`

	// A message added by the creator of the lock. This is typically used to give an
	// indication of why the resource is locked.
	Message *string `mandatory:"false" json:"message"`

	// When the lock was created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Indicates if the lock is active or not. For example, if there are mutliple FULL locks, the first-created FULL lock will be effective.
	IsActive *bool `mandatory:"false" json:"isActive"`
}

ResourceLock Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

func (ResourceLock) String ¶ added in v65.9.0

func (m ResourceLock) String() string

func (ResourceLock) ValidateEnumValue ¶ added in v65.9.0

func (m ResourceLock) 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

type ResourceLockTypeEnum ¶ added in v65.9.0

type ResourceLockTypeEnum string

ResourceLockTypeEnum Enum with underlying type: string

const (
	ResourceLockTypeFull   ResourceLockTypeEnum = "FULL"
	ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)

Set of constants representing the allowable values for ResourceLockTypeEnum

func GetMappingResourceLockTypeEnum ¶ added in v65.9.0

func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)

GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetResourceLockTypeEnumValues ¶ added in v65.9.0

func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum

GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum

type Saml2IdentityProvider ¶

type Saml2IdentityProvider struct {

	// The OCID of the `IdentityProvider`.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the `IdentityProvider`.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the `IdentityProvider` during creation. The name
	// must be unique across all `IdentityProvider` objects in the tenancy and
	// cannot be changed. This is the name federated users see when choosing
	// which identity provider to use when signing in to the Oracle Cloud Infrastructure
	// Console.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the `IdentityProvider` during creation. Does
	// not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// The identity provider service or product.
	// Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft
	// Active Directory Federation Services (ADFS).
	// Allowed values are:
	// - `ADFS`
	// - `IDCS`
	// Example: `IDCS`
	ProductType *string `mandatory:"true" json:"productType"`

	// Date and time the `IdentityProvider` was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The URL for retrieving the identity provider's metadata, which
	// contains information required for federating.
	MetadataUrl *string `mandatory:"true" json:"metadataUrl"`

	// The identity provider's signing certificate used by the IAM Service
	// to validate the SAML2 token.
	SigningCertificate *string `mandatory:"true" json:"signingCertificate"`

	// The URL to redirect federated users to for authentication with the
	// identity provider.
	RedirectUrl *string `mandatory:"true" json:"redirectUrl"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The XML that contains the information required for federating Identity with SAML2 Identity Provider.
	Metadata *string `mandatory:"false" json:"metadata"`

	// Extra name value pairs associated with this identity provider.
	// Example: `{"clientId": "app_sf3kdjf3"}`
	FreeformAttributes map[string]string `mandatory:"false" json:"freeformAttributes"`

	// The current state. After creating an `IdentityProvider`, make sure its
	// `lifecycleState` changes from CREATING to ACTIVE before using it.
	LifecycleState IdentityProviderLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

Saml2IdentityProvider A special type of IdentityProvider that supports the SAML 2.0 protocol. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm).

func (Saml2IdentityProvider) GetCompartmentId ¶

func (m Saml2IdentityProvider) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (Saml2IdentityProvider) GetDefinedTags ¶

func (m Saml2IdentityProvider) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (Saml2IdentityProvider) GetDescription ¶

func (m Saml2IdentityProvider) GetDescription() *string

GetDescription returns Description

func (Saml2IdentityProvider) GetFreeformTags ¶

func (m Saml2IdentityProvider) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (Saml2IdentityProvider) GetId ¶

func (m Saml2IdentityProvider) GetId() *string

GetId returns Id

func (Saml2IdentityProvider) GetInactiveStatus ¶

func (m Saml2IdentityProvider) GetInactiveStatus() *int64

GetInactiveStatus returns InactiveStatus

func (Saml2IdentityProvider) GetLifecycleState ¶

GetLifecycleState returns LifecycleState

func (Saml2IdentityProvider) GetName ¶

func (m Saml2IdentityProvider) GetName() *string

GetName returns Name

func (Saml2IdentityProvider) GetProductType ¶

func (m Saml2IdentityProvider) GetProductType() *string

GetProductType returns ProductType

func (Saml2IdentityProvider) GetTimeCreated ¶

func (m Saml2IdentityProvider) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (Saml2IdentityProvider) MarshalJSON ¶

func (m Saml2IdentityProvider) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (Saml2IdentityProvider) String ¶

func (m Saml2IdentityProvider) String() string

func (Saml2IdentityProvider) ValidateEnumValue ¶

func (m Saml2IdentityProvider) 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

type ScimClientCredentials ¶

type ScimClientCredentials struct {

	// The client identifier.
	ClientId *string `mandatory:"false" json:"clientId"`

	// The client secret.
	ClientSecret *string `mandatory:"false" json:"clientSecret"`
}

ScimClientCredentials The OAuth2 client credentials.

func (ScimClientCredentials) String ¶

func (m ScimClientCredentials) String() string

func (ScimClientCredentials) ValidateEnumValue ¶

func (m ScimClientCredentials) 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

type SmtpCredential ¶

type SmtpCredential struct {

	// The SMTP user name.
	Username *string `mandatory:"false" json:"username"`

	// The SMTP password.
	Password *string `mandatory:"false" json:"password"`

	// The OCID of the SMTP credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the SMTP credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// Date and time the `SmtpCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The credential's current state. After creating a SMTP credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState SmtpCredentialLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

SmtpCredential Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. The SMTP credentials are used for SMTP authentication with the service. The credentials never expire. A user can have up to 2 SMTP credentials at a time. **Note:** The credential set is always an Oracle-generated SMTP user name and password pair; you cannot designate the SMTP user name or the SMTP password. For more information, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm#SMTP).

func (SmtpCredential) String ¶

func (m SmtpCredential) String() string

func (SmtpCredential) ValidateEnumValue ¶

func (m SmtpCredential) 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

type SmtpCredentialLifecycleStateEnum ¶

type SmtpCredentialLifecycleStateEnum string

SmtpCredentialLifecycleStateEnum Enum with underlying type: string

const (
	SmtpCredentialLifecycleStateCreating SmtpCredentialLifecycleStateEnum = "CREATING"
	SmtpCredentialLifecycleStateActive   SmtpCredentialLifecycleStateEnum = "ACTIVE"
	SmtpCredentialLifecycleStateInactive SmtpCredentialLifecycleStateEnum = "INACTIVE"
	SmtpCredentialLifecycleStateDeleting SmtpCredentialLifecycleStateEnum = "DELETING"
	SmtpCredentialLifecycleStateDeleted  SmtpCredentialLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SmtpCredentialLifecycleStateEnum

func GetMappingSmtpCredentialLifecycleStateEnum ¶

func GetMappingSmtpCredentialLifecycleStateEnum(val string) (SmtpCredentialLifecycleStateEnum, bool)

GetMappingSmtpCredentialLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSmtpCredentialLifecycleStateEnumValues ¶

func GetSmtpCredentialLifecycleStateEnumValues() []SmtpCredentialLifecycleStateEnum

GetSmtpCredentialLifecycleStateEnumValues Enumerates the set of values for SmtpCredentialLifecycleStateEnum

type SmtpCredentialSummary ¶

type SmtpCredentialSummary struct {

	// The SMTP user name.
	Username *string `mandatory:"false" json:"username"`

	// The OCID of the SMTP credential.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the SMTP credential belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// Date and time the `SmtpCredential` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this credential will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The credential's current state. After creating a SMTP credential, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState SmtpCredentialSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

SmtpCredentialSummary As the name suggests, an `SmtpCredentialSummary` object contains information about an `SmtpCredential`. The SMTP credential is used for SMTP authentication with the Email Delivery Service (https://docs.cloud.oracle.com/Content/Email/Concepts/overview.htm).

func (SmtpCredentialSummary) String ¶

func (m SmtpCredentialSummary) String() string

func (SmtpCredentialSummary) ValidateEnumValue ¶

func (m SmtpCredentialSummary) 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

type SmtpCredentialSummaryLifecycleStateEnum ¶

type SmtpCredentialSummaryLifecycleStateEnum string

SmtpCredentialSummaryLifecycleStateEnum Enum with underlying type: string

const (
	SmtpCredentialSummaryLifecycleStateCreating SmtpCredentialSummaryLifecycleStateEnum = "CREATING"
	SmtpCredentialSummaryLifecycleStateActive   SmtpCredentialSummaryLifecycleStateEnum = "ACTIVE"
	SmtpCredentialSummaryLifecycleStateInactive SmtpCredentialSummaryLifecycleStateEnum = "INACTIVE"
	SmtpCredentialSummaryLifecycleStateDeleting SmtpCredentialSummaryLifecycleStateEnum = "DELETING"
	SmtpCredentialSummaryLifecycleStateDeleted  SmtpCredentialSummaryLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SmtpCredentialSummaryLifecycleStateEnum

func GetMappingSmtpCredentialSummaryLifecycleStateEnum ¶

func GetMappingSmtpCredentialSummaryLifecycleStateEnum(val string) (SmtpCredentialSummaryLifecycleStateEnum, bool)

GetMappingSmtpCredentialSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSmtpCredentialSummaryLifecycleStateEnumValues ¶

func GetSmtpCredentialSummaryLifecycleStateEnumValues() []SmtpCredentialSummaryLifecycleStateEnum

GetSmtpCredentialSummaryLifecycleStateEnumValues Enumerates the set of values for SmtpCredentialSummaryLifecycleStateEnum

type StandardTagDefinitionTemplate ¶

type StandardTagDefinitionTemplate struct {

	// The default description of the tag namespace that users can use to create the tag definition
	Description *string `mandatory:"true" json:"description"`

	// The name of this standard tag definition
	TagDefinitionName *string `mandatory:"true" json:"tagDefinitionName"`

	// The type of tag definition. Enum or string.
	Type StandardTagDefinitionTemplateTypeEnum `mandatory:"true" json:"type"`

	// Is the tag a cost tracking tag. Default will be false as cost tracking tags have been deprecated
	IsCostTracking *bool `mandatory:"true" json:"isCostTracking"`

	// List of possible values. An optional parameter that will be present if the type of definition is enum.
	PossibleValues []string `mandatory:"false" json:"possibleValues"`

	// The mutability of the possible values list for enum tags. This will default to IMMUTABLE for string value tags
	EnumMutability StandardTagDefinitionTemplateEnumMutabilityEnum `mandatory:"false" json:"enumMutability,omitempty"`
}

StandardTagDefinitionTemplate The template of the tag definition. This object includes necessary details to create the provided standard tag definition.

func (StandardTagDefinitionTemplate) String ¶

func (StandardTagDefinitionTemplate) ValidateEnumValue ¶

func (m StandardTagDefinitionTemplate) 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

type StandardTagDefinitionTemplateEnumMutabilityEnum ¶

type StandardTagDefinitionTemplateEnumMutabilityEnum string

StandardTagDefinitionTemplateEnumMutabilityEnum Enum with underlying type: string

const (
	StandardTagDefinitionTemplateEnumMutabilityImmutable  StandardTagDefinitionTemplateEnumMutabilityEnum = "IMMUTABLE"
	StandardTagDefinitionTemplateEnumMutabilityMutable    StandardTagDefinitionTemplateEnumMutabilityEnum = "MUTABLE"
	StandardTagDefinitionTemplateEnumMutabilityAppendable StandardTagDefinitionTemplateEnumMutabilityEnum = "APPENDABLE"
)

Set of constants representing the allowable values for StandardTagDefinitionTemplateEnumMutabilityEnum

func GetMappingStandardTagDefinitionTemplateEnumMutabilityEnum ¶

func GetMappingStandardTagDefinitionTemplateEnumMutabilityEnum(val string) (StandardTagDefinitionTemplateEnumMutabilityEnum, bool)

GetMappingStandardTagDefinitionTemplateEnumMutabilityEnum performs case Insensitive comparison on enum value and return the desired enum

func GetStandardTagDefinitionTemplateEnumMutabilityEnumValues ¶

func GetStandardTagDefinitionTemplateEnumMutabilityEnumValues() []StandardTagDefinitionTemplateEnumMutabilityEnum

GetStandardTagDefinitionTemplateEnumMutabilityEnumValues Enumerates the set of values for StandardTagDefinitionTemplateEnumMutabilityEnum

type StandardTagDefinitionTemplateTypeEnum ¶

type StandardTagDefinitionTemplateTypeEnum string

StandardTagDefinitionTemplateTypeEnum Enum with underlying type: string

const (
	StandardTagDefinitionTemplateTypeEnumvalue StandardTagDefinitionTemplateTypeEnum = "ENUM"
	StandardTagDefinitionTemplateTypeString    StandardTagDefinitionTemplateTypeEnum = "STRING"
)

Set of constants representing the allowable values for StandardTagDefinitionTemplateTypeEnum

func GetMappingStandardTagDefinitionTemplateTypeEnum ¶

func GetMappingStandardTagDefinitionTemplateTypeEnum(val string) (StandardTagDefinitionTemplateTypeEnum, bool)

GetMappingStandardTagDefinitionTemplateTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetStandardTagDefinitionTemplateTypeEnumValues ¶

func GetStandardTagDefinitionTemplateTypeEnumValues() []StandardTagDefinitionTemplateTypeEnum

GetStandardTagDefinitionTemplateTypeEnumValues Enumerates the set of values for StandardTagDefinitionTemplateTypeEnum

type StandardTagNamespaceTemplate ¶

type StandardTagNamespaceTemplate struct {

	// The default description of the tag namespace that users can use to create the tag namespace
	Description *string `mandatory:"true" json:"description"`

	// The reserved name of this standard tag namespace
	StandardTagNamespaceName *string `mandatory:"true" json:"standardTagNamespaceName"`

	// The template of the tag definition. This object includes necessary details to create the provided standard tag definition.
	TagDefinitionTemplates []StandardTagDefinitionTemplate `mandatory:"true" json:"tagDefinitionTemplates"`

	// The status of the standard tag namespace
	Status *string `mandatory:"true" json:"status"`
}

StandardTagNamespaceTemplate The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace.

func (StandardTagNamespaceTemplate) String ¶

func (StandardTagNamespaceTemplate) ValidateEnumValue ¶

func (m StandardTagNamespaceTemplate) 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

type StandardTagNamespaceTemplateSummary ¶

type StandardTagNamespaceTemplateSummary struct {

	// The default description of the tag namespace that users can use to create the tag namespace
	Description *string `mandatory:"true" json:"description"`

	// The reserved name of this standard tag namespace
	StandardTagNamespaceName *string `mandatory:"true" json:"standardTagNamespaceName"`

	// The status of the standard tag namespace
	Status *string `mandatory:"true" json:"status"`
}

StandardTagNamespaceTemplateSummary The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace.

func (StandardTagNamespaceTemplateSummary) String ¶

func (StandardTagNamespaceTemplateSummary) ValidateEnumValue ¶

func (m StandardTagNamespaceTemplateSummary) 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

type SwiftPassword ¶

type SwiftPassword struct {

	// The Swift password. The value is available only in the response for `CreateSwiftPassword`, and not
	// for `ListSwiftPasswords` or `UpdateSwiftPassword`.
	Password *string `mandatory:"false" json:"password"`

	// The OCID of the Swift password.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the user the password belongs to.
	UserId *string `mandatory:"false" json:"userId"`

	// The description you assign to the Swift password. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// Date and time the `SwiftPassword` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Date and time when this password will expire, in the format defined by RFC3339.
	// Null if it never expires.
	// Example: `2016-08-25T21:10:29.600Z`
	ExpiresOn *common.SDKTime `mandatory:"false" json:"expiresOn"`

	// The password's current state. After creating a password, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState SwiftPasswordLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

SwiftPassword **Deprecated. Use AuthToken instead.** Swift is the OpenStack object storage service. A `SwiftPassword` is an Oracle-provided password for using a Swift client with the Object Storage Service. This password is associated with the user's Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time. **Note:** The password is always an Oracle-generated string; you can't change it to a string of your choice. For more information, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm).

func (SwiftPassword) String ¶

func (m SwiftPassword) String() string

func (SwiftPassword) ValidateEnumValue ¶

func (m SwiftPassword) 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

type SwiftPasswordLifecycleStateEnum ¶

type SwiftPasswordLifecycleStateEnum string

SwiftPasswordLifecycleStateEnum Enum with underlying type: string

const (
	SwiftPasswordLifecycleStateCreating SwiftPasswordLifecycleStateEnum = "CREATING"
	SwiftPasswordLifecycleStateActive   SwiftPasswordLifecycleStateEnum = "ACTIVE"
	SwiftPasswordLifecycleStateInactive SwiftPasswordLifecycleStateEnum = "INACTIVE"
	SwiftPasswordLifecycleStateDeleting SwiftPasswordLifecycleStateEnum = "DELETING"
	SwiftPasswordLifecycleStateDeleted  SwiftPasswordLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SwiftPasswordLifecycleStateEnum

func GetMappingSwiftPasswordLifecycleStateEnum ¶

func GetMappingSwiftPasswordLifecycleStateEnum(val string) (SwiftPasswordLifecycleStateEnum, bool)

GetMappingSwiftPasswordLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSwiftPasswordLifecycleStateEnumValues ¶

func GetSwiftPasswordLifecycleStateEnumValues() []SwiftPasswordLifecycleStateEnum

GetSwiftPasswordLifecycleStateEnumValues Enumerates the set of values for SwiftPasswordLifecycleStateEnum

type Tag ¶

type Tag struct {

	// The OCID of the compartment that contains the tag definition.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the namespace that contains the tag definition.
	TagNamespaceId *string `mandatory:"true" json:"tagNamespaceId"`

	// The name of the tag namespace that contains the tag definition.
	TagNamespaceName *string `mandatory:"true" json:"tagNamespaceName"`

	// The OCID of the tag definition.
	Id *string `mandatory:"true" json:"id"`

	// The name assigned to the tag during creation. This is the tag key definition.
	// The name must be unique within the tag namespace and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the tag.
	Description *string `mandatory:"true" json:"description"`

	// Indicates whether the tag is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
	IsRetired *bool `mandatory:"true" json:"isRetired"`

	// Date and time the tag was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The tag's current state. After creating a tag, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's `lifecycleState` changes from DELETING to DELETED.
	LifecycleState TagLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Indicates whether the tag is enabled for cost tracking.
	IsCostTracking *bool `mandatory:"false" json:"isCostTracking"`

	Validator BaseTagDefinitionValidator `mandatory:"false" json:"validator"`
}

Tag A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before you can apply them to resources. For more information, see Managing Tags and Tag Namespaces (https://docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Tag) String ¶

func (m Tag) String() string

func (*Tag) UnmarshalJSON ¶

func (m *Tag) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Tag) ValidateEnumValue ¶

func (m Tag) 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

type TagDefault ¶

type TagDefault struct {

	// The OCID of the tag default.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment. The tag default applies to all new resources that get created in the
	// compartment. Resources that existed before the tag default was created are not tagged.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the tag namespace that contains the tag definition.
	TagNamespaceId *string `mandatory:"true" json:"tagNamespaceId"`

	// The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
	TagDefinitionId *string `mandatory:"true" json:"tagDefinitionId"`

	// The name used in the tag definition. This field is informational in the context of the tag default.
	TagDefinitionName *string `mandatory:"true" json:"tagDefinitionName"`

	// The default value for the tag definition. This will be applied to all resources created in the compartment.
	Value *string `mandatory:"true" json:"value"`

	// Date and time the `TagDefault` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// If you specify that a value is required, a value is set during resource creation (either by the
	// user creating the resource or another tag defualt). If no value is set, resource creation is
	// blocked.
	// * If the `isRequired` flag is set to "true", the value is set during resource creation.
	// * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.
	// Example: `false`
	IsRequired *bool `mandatory:"true" json:"isRequired"`

	// The tag default's current state. After creating a `TagDefault`, make sure its `lifecycleState` is ACTIVE before using it.
	LifecycleState TagDefaultLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

TagDefault Tag defaults let you specify a default tag (tagnamespace.tag="value") to apply to all resource types in a specified compartment. The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged. The `TagDefault` object specifies the tag and compartment details. Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment for a tenancy, all resources that are created in the tenancy are tagged. For more information about using tag defaults, see Managing Tag Defaults (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagdefaults.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.

func (TagDefault) String ¶

func (m TagDefault) String() string

func (TagDefault) ValidateEnumValue ¶

func (m TagDefault) 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

type TagDefaultLifecycleStateEnum ¶

type TagDefaultLifecycleStateEnum string

TagDefaultLifecycleStateEnum Enum with underlying type: string

const (
	TagDefaultLifecycleStateActive TagDefaultLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for TagDefaultLifecycleStateEnum

func GetMappingTagDefaultLifecycleStateEnum ¶

func GetMappingTagDefaultLifecycleStateEnum(val string) (TagDefaultLifecycleStateEnum, bool)

GetMappingTagDefaultLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTagDefaultLifecycleStateEnumValues ¶

func GetTagDefaultLifecycleStateEnumValues() []TagDefaultLifecycleStateEnum

GetTagDefaultLifecycleStateEnumValues Enumerates the set of values for TagDefaultLifecycleStateEnum

type TagDefaultSummary ¶

type TagDefaultSummary struct {

	// The OCID of the tag default.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the tag namespace that contains the tag definition.
	TagNamespaceId *string `mandatory:"true" json:"tagNamespaceId"`

	// The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
	TagDefinitionId *string `mandatory:"true" json:"tagDefinitionId"`

	// The name used in the tag definition. This field is informational in the context of the tag default.
	TagDefinitionName *string `mandatory:"true" json:"tagDefinitionName"`

	// The default value for the tag definition. This will be applied to all new resources created in the compartment.
	Value *string `mandatory:"true" json:"value"`

	// Date and time the `TagDefault` object was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// If you specify that a value is required, a value is set during resource creation (either by
	// the user creating the resource or another tag defualt). If no value is set, resource
	// creation is blocked.
	// * If the `isRequired` flag is set to "true", the value is set during resource creation.
	// * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.
	// Example: `false`
	IsRequired *bool `mandatory:"true" json:"isRequired"`

	// The tag default's current state. After creating a `TagDefault`, make sure its `lifecycleState` is ACTIVE before using it.
	LifecycleState TagDefaultSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

TagDefaultSummary Summary information for the specified tag default.

func (TagDefaultSummary) String ¶

func (m TagDefaultSummary) String() string

func (TagDefaultSummary) ValidateEnumValue ¶

func (m TagDefaultSummary) 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

type TagDefaultSummaryLifecycleStateEnum ¶

type TagDefaultSummaryLifecycleStateEnum string

TagDefaultSummaryLifecycleStateEnum Enum with underlying type: string

const (
	TagDefaultSummaryLifecycleStateActive TagDefaultSummaryLifecycleStateEnum = "ACTIVE"
)

Set of constants representing the allowable values for TagDefaultSummaryLifecycleStateEnum

func GetMappingTagDefaultSummaryLifecycleStateEnum ¶

func GetMappingTagDefaultSummaryLifecycleStateEnum(val string) (TagDefaultSummaryLifecycleStateEnum, bool)

GetMappingTagDefaultSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTagDefaultSummaryLifecycleStateEnumValues ¶

func GetTagDefaultSummaryLifecycleStateEnumValues() []TagDefaultSummaryLifecycleStateEnum

GetTagDefaultSummaryLifecycleStateEnumValues Enumerates the set of values for TagDefaultSummaryLifecycleStateEnum

type TagLifecycleStateEnum ¶

type TagLifecycleStateEnum string

TagLifecycleStateEnum Enum with underlying type: string

const (
	TagLifecycleStateActive   TagLifecycleStateEnum = "ACTIVE"
	TagLifecycleStateInactive TagLifecycleStateEnum = "INACTIVE"
	TagLifecycleStateDeleting TagLifecycleStateEnum = "DELETING"
	TagLifecycleStateDeleted  TagLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for TagLifecycleStateEnum

func GetMappingTagLifecycleStateEnum ¶

func GetMappingTagLifecycleStateEnum(val string) (TagLifecycleStateEnum, bool)

GetMappingTagLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTagLifecycleStateEnumValues ¶

func GetTagLifecycleStateEnumValues() []TagLifecycleStateEnum

GetTagLifecycleStateEnumValues Enumerates the set of values for TagLifecycleStateEnum

type TagNamespace ¶

type TagNamespace struct {

	// The OCID of the tag namespace.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment that contains the tag namespace.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the tag namespace.
	Description *string `mandatory:"true" json:"description"`

	// Whether the tag namespace is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
	IsRetired *bool `mandatory:"true" json:"isRetired"`

	// Date and time the tagNamespace was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The tagnamespace's current state. After creating a tagnamespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tagnamespace, make sure its `lifecycleState` is INACTIVE before using it.
	LifecycleState TagNamespaceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

TagNamespace A managed container for defined tags. A tag namespace is unique in a tenancy. For more information, see Managing Tags and Tag Namespaces (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (TagNamespace) String ¶

func (m TagNamespace) String() string

func (TagNamespace) ValidateEnumValue ¶

func (m TagNamespace) 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

type TagNamespaceLifecycleStateEnum ¶

type TagNamespaceLifecycleStateEnum string

TagNamespaceLifecycleStateEnum Enum with underlying type: string

const (
	TagNamespaceLifecycleStateActive   TagNamespaceLifecycleStateEnum = "ACTIVE"
	TagNamespaceLifecycleStateInactive TagNamespaceLifecycleStateEnum = "INACTIVE"
	TagNamespaceLifecycleStateDeleting TagNamespaceLifecycleStateEnum = "DELETING"
	TagNamespaceLifecycleStateDeleted  TagNamespaceLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for TagNamespaceLifecycleStateEnum

func GetMappingTagNamespaceLifecycleStateEnum ¶

func GetMappingTagNamespaceLifecycleStateEnum(val string) (TagNamespaceLifecycleStateEnum, bool)

GetMappingTagNamespaceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTagNamespaceLifecycleStateEnumValues ¶

func GetTagNamespaceLifecycleStateEnumValues() []TagNamespaceLifecycleStateEnum

GetTagNamespaceLifecycleStateEnumValues Enumerates the set of values for TagNamespaceLifecycleStateEnum

type TagNamespaceSummary ¶

type TagNamespaceSummary struct {

	// The OCID of the tag namespace.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the compartment that contains the tag namespace.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
	Name *string `mandatory:"false" json:"name"`

	// The description you assign to the tag namespace.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Whether the tag namespace is retired.
	// For more information, see Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

	// The tagnamespace's current state. After creating a tagnamespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tagnamespace, make sure its `lifecycleState` is INACTIVE before using it.
	LifecycleState TagNamespaceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Date and time the tag namespace was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Locks associated with this resource.
	Locks []ResourceLock `mandatory:"false" json:"locks"`
}

TagNamespaceSummary A container for defined tags.

func (TagNamespaceSummary) String ¶

func (m TagNamespaceSummary) String() string

func (TagNamespaceSummary) ValidateEnumValue ¶

func (m TagNamespaceSummary) 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

type TagSummary ¶

type TagSummary struct {

	// The OCID of the compartment that contains the tag definition.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The OCID of the tag definition.
	Id *string `mandatory:"false" json:"id"`

	// The name assigned to the tag during creation. This is the tag key definition.
	// The name must be unique within the tag namespace and cannot be changed.
	Name *string `mandatory:"false" json:"name"`

	// The description you assign to the tag.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Whether the tag is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

	// The tag's current state. After creating a tag, make sure its `lifecycleState` is ACTIVE before using it. After retiring a tag, make sure its `lifecycleState` is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's `lifecycleState` changes from DELETING to DELETED.
	LifecycleState TagLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Date and time the tag was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Indicates whether the tag is enabled for cost tracking.
	IsCostTracking *bool `mandatory:"false" json:"isCostTracking"`
}

TagSummary A tag definition that belongs to a specific tag namespace.

func (TagSummary) String ¶

func (m TagSummary) String() string

func (TagSummary) ValidateEnumValue ¶

func (m TagSummary) 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

type TaggingWorkRequest ¶

type TaggingWorkRequest struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// An enum-like description of the type of work the work request is doing.
	OperationType TaggingWorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status TaggingWorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment that contains the work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"false" json:"resources"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
}

TaggingWorkRequest The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

func (TaggingWorkRequest) String ¶

func (m TaggingWorkRequest) String() string

func (TaggingWorkRequest) ValidateEnumValue ¶

func (m TaggingWorkRequest) 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

type TaggingWorkRequestErrorSummary ¶

type TaggingWorkRequestErrorSummary struct {

	// A machine-usable code for the error that occured.
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the error happened, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

TaggingWorkRequestErrorSummary The error entity.

func (TaggingWorkRequestErrorSummary) String ¶

func (TaggingWorkRequestErrorSummary) ValidateEnumValue ¶

func (m TaggingWorkRequestErrorSummary) 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

type TaggingWorkRequestLogSummary ¶

type TaggingWorkRequestLogSummary struct {

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the log was written, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

TaggingWorkRequestLogSummary The log entity.

func (TaggingWorkRequestLogSummary) String ¶

func (TaggingWorkRequestLogSummary) ValidateEnumValue ¶

func (m TaggingWorkRequestLogSummary) 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

type TaggingWorkRequestOperationTypeEnum ¶

type TaggingWorkRequestOperationTypeEnum string

TaggingWorkRequestOperationTypeEnum Enum with underlying type: string

const (
	TaggingWorkRequestOperationTypeDeleteTagDefinition        TaggingWorkRequestOperationTypeEnum = "DELETE_TAG_DEFINITION"
	TaggingWorkRequestOperationTypeDeleteNonEmptyTagNamespace TaggingWorkRequestOperationTypeEnum = "DELETE_NON_EMPTY_TAG_NAMESPACE"
	TaggingWorkRequestOperationTypeBulkDeleteTagDefinition    TaggingWorkRequestOperationTypeEnum = "BULK_DELETE_TAG_DEFINITION"
	TaggingWorkRequestOperationTypeBulkEditOfTags             TaggingWorkRequestOperationTypeEnum = "BULK_EDIT_OF_TAGS"
	TaggingWorkRequestOperationTypeImportStandardTags         TaggingWorkRequestOperationTypeEnum = "IMPORT_STANDARD_TAGS"
)

Set of constants representing the allowable values for TaggingWorkRequestOperationTypeEnum

func GetMappingTaggingWorkRequestOperationTypeEnum ¶

func GetMappingTaggingWorkRequestOperationTypeEnum(val string) (TaggingWorkRequestOperationTypeEnum, bool)

GetMappingTaggingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTaggingWorkRequestOperationTypeEnumValues ¶

func GetTaggingWorkRequestOperationTypeEnumValues() []TaggingWorkRequestOperationTypeEnum

GetTaggingWorkRequestOperationTypeEnumValues Enumerates the set of values for TaggingWorkRequestOperationTypeEnum

type TaggingWorkRequestStatusEnum ¶

type TaggingWorkRequestStatusEnum string

TaggingWorkRequestStatusEnum Enum with underlying type: string

const (
	TaggingWorkRequestStatusAccepted           TaggingWorkRequestStatusEnum = "ACCEPTED"
	TaggingWorkRequestStatusInProgress         TaggingWorkRequestStatusEnum = "IN_PROGRESS"
	TaggingWorkRequestStatusFailed             TaggingWorkRequestStatusEnum = "FAILED"
	TaggingWorkRequestStatusSucceeded          TaggingWorkRequestStatusEnum = "SUCCEEDED"
	TaggingWorkRequestStatusPartiallySucceeded TaggingWorkRequestStatusEnum = "PARTIALLY_SUCCEEDED"
	TaggingWorkRequestStatusCanceling          TaggingWorkRequestStatusEnum = "CANCELING"
	TaggingWorkRequestStatusCanceled           TaggingWorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for TaggingWorkRequestStatusEnum

func GetMappingTaggingWorkRequestStatusEnum ¶

func GetMappingTaggingWorkRequestStatusEnum(val string) (TaggingWorkRequestStatusEnum, bool)

GetMappingTaggingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTaggingWorkRequestStatusEnumValues ¶

func GetTaggingWorkRequestStatusEnumValues() []TaggingWorkRequestStatusEnum

GetTaggingWorkRequestStatusEnumValues Enumerates the set of values for TaggingWorkRequestStatusEnum

type TaggingWorkRequestSummary ¶

type TaggingWorkRequestSummary struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// An enum-like description of the type of work the work request is doing.
	OperationType TaggingWorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status TaggingWorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment that contains the work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"false" json:"resources"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
}

TaggingWorkRequestSummary The work request summary. Tracks the status of the asynchronous operation.

func (TaggingWorkRequestSummary) String ¶

func (m TaggingWorkRequestSummary) String() string

func (TaggingWorkRequestSummary) ValidateEnumValue ¶

func (m TaggingWorkRequestSummary) 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

type TaggingWorkRequestSummaryOperationTypeEnum ¶

type TaggingWorkRequestSummaryOperationTypeEnum string

TaggingWorkRequestSummaryOperationTypeEnum Enum with underlying type: string

const (
	TaggingWorkRequestSummaryOperationTypeDeleteTagDefinition        TaggingWorkRequestSummaryOperationTypeEnum = "DELETE_TAG_DEFINITION"
	TaggingWorkRequestSummaryOperationTypeDeleteNonEmptyTagNamespace TaggingWorkRequestSummaryOperationTypeEnum = "DELETE_NON_EMPTY_TAG_NAMESPACE"
	TaggingWorkRequestSummaryOperationTypeBulkDeleteTagDefinition    TaggingWorkRequestSummaryOperationTypeEnum = "BULK_DELETE_TAG_DEFINITION"
	TaggingWorkRequestSummaryOperationTypeBulkEditOfTags             TaggingWorkRequestSummaryOperationTypeEnum = "BULK_EDIT_OF_TAGS"
	TaggingWorkRequestSummaryOperationTypeImportStandardTags         TaggingWorkRequestSummaryOperationTypeEnum = "IMPORT_STANDARD_TAGS"
)

Set of constants representing the allowable values for TaggingWorkRequestSummaryOperationTypeEnum

func GetMappingTaggingWorkRequestSummaryOperationTypeEnum ¶

func GetMappingTaggingWorkRequestSummaryOperationTypeEnum(val string) (TaggingWorkRequestSummaryOperationTypeEnum, bool)

GetMappingTaggingWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTaggingWorkRequestSummaryOperationTypeEnumValues ¶

func GetTaggingWorkRequestSummaryOperationTypeEnumValues() []TaggingWorkRequestSummaryOperationTypeEnum

GetTaggingWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for TaggingWorkRequestSummaryOperationTypeEnum

type TaggingWorkRequestSummaryStatusEnum ¶

type TaggingWorkRequestSummaryStatusEnum string

TaggingWorkRequestSummaryStatusEnum Enum with underlying type: string

const (
	TaggingWorkRequestSummaryStatusAccepted           TaggingWorkRequestSummaryStatusEnum = "ACCEPTED"
	TaggingWorkRequestSummaryStatusInProgress         TaggingWorkRequestSummaryStatusEnum = "IN_PROGRESS"
	TaggingWorkRequestSummaryStatusFailed             TaggingWorkRequestSummaryStatusEnum = "FAILED"
	TaggingWorkRequestSummaryStatusSucceeded          TaggingWorkRequestSummaryStatusEnum = "SUCCEEDED"
	TaggingWorkRequestSummaryStatusPartiallySucceeded TaggingWorkRequestSummaryStatusEnum = "PARTIALLY_SUCCEEDED"
	TaggingWorkRequestSummaryStatusCanceling          TaggingWorkRequestSummaryStatusEnum = "CANCELING"
	TaggingWorkRequestSummaryStatusCanceled           TaggingWorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for TaggingWorkRequestSummaryStatusEnum

func GetMappingTaggingWorkRequestSummaryStatusEnum ¶

func GetMappingTaggingWorkRequestSummaryStatusEnum(val string) (TaggingWorkRequestSummaryStatusEnum, bool)

GetMappingTaggingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTaggingWorkRequestSummaryStatusEnumValues ¶

func GetTaggingWorkRequestSummaryStatusEnumValues() []TaggingWorkRequestSummaryStatusEnum

GetTaggingWorkRequestSummaryStatusEnumValues Enumerates the set of values for TaggingWorkRequestSummaryStatusEnum

type Tenancy ¶

type Tenancy struct {

	// The OCID of the tenancy.
	Id *string `mandatory:"false" json:"id"`

	// The name of the tenancy.
	Name *string `mandatory:"false" json:"name"`

	// The description of the tenancy.
	Description *string `mandatory:"false" json:"description"`

	// The region key for the tenancy's home region. For the full list of supported regions, see
	// Regions and Availability Domains (https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
	// Example: `PHX`
	HomeRegionKey *string `mandatory:"false" json:"homeRegionKey"`

	// Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's home region.
	UpiIdcsCompatibilityLayerEndpoint *string `mandatory:"false" json:"upiIdcsCompatibilityLayerEndpoint"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Tenancy The root compartment that contains all of your organization's compartments and other Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure, Oracle creates a tenancy for your company, which is a secure and isolated partition where you can create, organize, and administer your cloud resources. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm).

func (Tenancy) String ¶

func (m Tenancy) String() string

func (Tenancy) ValidateEnumValue ¶

func (m Tenancy) 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

type UiPassword ¶

type UiPassword struct {

	// The user's password for the Console.
	Password *string `mandatory:"false" json:"password"`

	// The OCID of the user.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time the password was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The password's current state. After creating a password, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState UiPasswordLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

UiPassword A text password that enables a user to sign in to the Console, the user interface for interacting with Oracle Cloud Infrastructure. For more information about user credentials, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/usercred/usercredentials.htm).

func (UiPassword) String ¶

func (m UiPassword) String() string

func (UiPassword) ValidateEnumValue ¶

func (m UiPassword) 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

type UiPasswordInformation ¶

type UiPasswordInformation struct {

	// The OCID of the user.
	UserId *string `mandatory:"false" json:"userId"`

	// Date and time the password was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The password's current state. After creating a password, make sure its `lifecycleState` changes from
	// CREATING to ACTIVE before using it.
	LifecycleState UiPasswordInformationLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

UiPasswordInformation Information about the UIPassword, which is a text password that enables a user to sign in to the Console, the user interface for interacting with Oracle Cloud Infrastructure. For more information about user credentials, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm).

func (UiPasswordInformation) String ¶

func (m UiPasswordInformation) String() string

func (UiPasswordInformation) ValidateEnumValue ¶

func (m UiPasswordInformation) 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

type UiPasswordInformationLifecycleStateEnum ¶

type UiPasswordInformationLifecycleStateEnum string

UiPasswordInformationLifecycleStateEnum Enum with underlying type: string

const (
	UiPasswordInformationLifecycleStateCreating UiPasswordInformationLifecycleStateEnum = "CREATING"
	UiPasswordInformationLifecycleStateActive   UiPasswordInformationLifecycleStateEnum = "ACTIVE"
	UiPasswordInformationLifecycleStateInactive UiPasswordInformationLifecycleStateEnum = "INACTIVE"
	UiPasswordInformationLifecycleStateDeleting UiPasswordInformationLifecycleStateEnum = "DELETING"
	UiPasswordInformationLifecycleStateDeleted  UiPasswordInformationLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UiPasswordInformationLifecycleStateEnum

func GetMappingUiPasswordInformationLifecycleStateEnum ¶

func GetMappingUiPasswordInformationLifecycleStateEnum(val string) (UiPasswordInformationLifecycleStateEnum, bool)

GetMappingUiPasswordInformationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUiPasswordInformationLifecycleStateEnumValues ¶

func GetUiPasswordInformationLifecycleStateEnumValues() []UiPasswordInformationLifecycleStateEnum

GetUiPasswordInformationLifecycleStateEnumValues Enumerates the set of values for UiPasswordInformationLifecycleStateEnum

type UiPasswordLifecycleStateEnum ¶

type UiPasswordLifecycleStateEnum string

UiPasswordLifecycleStateEnum Enum with underlying type: string

const (
	UiPasswordLifecycleStateCreating UiPasswordLifecycleStateEnum = "CREATING"
	UiPasswordLifecycleStateActive   UiPasswordLifecycleStateEnum = "ACTIVE"
	UiPasswordLifecycleStateInactive UiPasswordLifecycleStateEnum = "INACTIVE"
	UiPasswordLifecycleStateDeleting UiPasswordLifecycleStateEnum = "DELETING"
	UiPasswordLifecycleStateDeleted  UiPasswordLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UiPasswordLifecycleStateEnum

func GetMappingUiPasswordLifecycleStateEnum ¶

func GetMappingUiPasswordLifecycleStateEnum(val string) (UiPasswordLifecycleStateEnum, bool)

GetMappingUiPasswordLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUiPasswordLifecycleStateEnumValues ¶

func GetUiPasswordLifecycleStateEnumValues() []UiPasswordLifecycleStateEnum

GetUiPasswordLifecycleStateEnumValues Enumerates the set of values for UiPasswordLifecycleStateEnum

type UpdateAuthTokenDetails ¶

type UpdateAuthTokenDetails struct {

	// The description you assign to the auth token. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`
}

UpdateAuthTokenDetails The representation of UpdateAuthTokenDetails

func (UpdateAuthTokenDetails) String ¶

func (m UpdateAuthTokenDetails) String() string

func (UpdateAuthTokenDetails) ValidateEnumValue ¶

func (m UpdateAuthTokenDetails) 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

type UpdateAuthTokenRequest ¶

type UpdateAuthTokenRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the auth token.
	AuthTokenId *string `mandatory:"true" contributesTo:"path" name:"authTokenId"`

	// Request object for updating an auth token.
	UpdateAuthTokenDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateAuthTokenRequest wrapper for the UpdateAuthToken operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateAuthToken.go.html to see an example of how to use UpdateAuthTokenRequest.

func (UpdateAuthTokenRequest) BinaryRequestBody ¶

func (request UpdateAuthTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAuthTokenRequest) HTTPRequest ¶

func (request UpdateAuthTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAuthTokenRequest) RetryPolicy ¶

func (request UpdateAuthTokenRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAuthTokenRequest) String ¶

func (request UpdateAuthTokenRequest) String() string

func (UpdateAuthTokenRequest) ValidateEnumValue ¶

func (request UpdateAuthTokenRequest) 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

type UpdateAuthTokenResponse ¶

type UpdateAuthTokenResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AuthToken instance
	AuthToken `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateAuthTokenResponse wrapper for the UpdateAuthToken operation

func (UpdateAuthTokenResponse) HTTPResponse ¶

func (response UpdateAuthTokenResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAuthTokenResponse) String ¶

func (response UpdateAuthTokenResponse) String() string

type UpdateAuthenticationPolicyDetails ¶

type UpdateAuthenticationPolicyDetails struct {
	PasswordPolicy *PasswordPolicy `mandatory:"false" json:"passwordPolicy"`

	NetworkPolicy *NetworkPolicy `mandatory:"false" json:"networkPolicy"`
}

UpdateAuthenticationPolicyDetails Update request for authentication policy, describes set of validation rules and their parameters to be updated.

func (UpdateAuthenticationPolicyDetails) String ¶

func (UpdateAuthenticationPolicyDetails) ValidateEnumValue ¶

func (m UpdateAuthenticationPolicyDetails) 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

type UpdateAuthenticationPolicyRequest ¶

type UpdateAuthenticationPolicyRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// Request object for updating the authentication policy.
	UpdateAuthenticationPolicyDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateAuthenticationPolicyRequest wrapper for the UpdateAuthenticationPolicy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateAuthenticationPolicy.go.html to see an example of how to use UpdateAuthenticationPolicyRequest.

func (UpdateAuthenticationPolicyRequest) BinaryRequestBody ¶

func (request UpdateAuthenticationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAuthenticationPolicyRequest) HTTPRequest ¶

func (request UpdateAuthenticationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAuthenticationPolicyRequest) RetryPolicy ¶

func (request UpdateAuthenticationPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAuthenticationPolicyRequest) String ¶

func (request UpdateAuthenticationPolicyRequest) String() string

func (UpdateAuthenticationPolicyRequest) ValidateEnumValue ¶

func (request UpdateAuthenticationPolicyRequest) 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

type UpdateAuthenticationPolicyResponse ¶

type UpdateAuthenticationPolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AuthenticationPolicy instance
	AuthenticationPolicy `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateAuthenticationPolicyResponse wrapper for the UpdateAuthenticationPolicy operation

func (UpdateAuthenticationPolicyResponse) HTTPResponse ¶

func (response UpdateAuthenticationPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAuthenticationPolicyResponse) String ¶

func (response UpdateAuthenticationPolicyResponse) String() string

type UpdateCompartmentDetails ¶

type UpdateCompartmentDetails struct {

	// The description you assign to the compartment. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// The new name you assign to the compartment. The name must be unique across all compartments in the parent compartment.
	// Avoid entering confidential information.
	Name *string `mandatory:"false" json:"name"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateCompartmentDetails The representation of UpdateCompartmentDetails

func (UpdateCompartmentDetails) String ¶

func (m UpdateCompartmentDetails) String() string

func (UpdateCompartmentDetails) ValidateEnumValue ¶

func (m UpdateCompartmentDetails) 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

type UpdateCompartmentRequest ¶

type UpdateCompartmentRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"path" name:"compartmentId"`

	// Request object for updating a compartment.
	UpdateCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateCompartmentRequest wrapper for the UpdateCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateCompartment.go.html to see an example of how to use UpdateCompartmentRequest.

func (UpdateCompartmentRequest) BinaryRequestBody ¶

func (request UpdateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateCompartmentRequest) HTTPRequest ¶

func (request UpdateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateCompartmentRequest) RetryPolicy ¶

func (request UpdateCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateCompartmentRequest) String ¶

func (request UpdateCompartmentRequest) String() string

func (UpdateCompartmentRequest) ValidateEnumValue ¶

func (request UpdateCompartmentRequest) 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

type UpdateCompartmentResponse ¶

type UpdateCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Compartment instance
	Compartment `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateCompartmentResponse wrapper for the UpdateCompartment operation

func (UpdateCompartmentResponse) HTTPResponse ¶

func (response UpdateCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateCompartmentResponse) String ¶

func (response UpdateCompartmentResponse) String() string

type UpdateCustomerSecretKeyDetails ¶

type UpdateCustomerSecretKeyDetails struct {

	// The description you assign to the secret key. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

UpdateCustomerSecretKeyDetails The representation of UpdateCustomerSecretKeyDetails

func (UpdateCustomerSecretKeyDetails) String ¶

func (UpdateCustomerSecretKeyDetails) ValidateEnumValue ¶

func (m UpdateCustomerSecretKeyDetails) 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

type UpdateCustomerSecretKeyRequest ¶

type UpdateCustomerSecretKeyRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The access token of the secret key.
	CustomerSecretKeyId *string `mandatory:"true" contributesTo:"path" name:"customerSecretKeyId"`

	// Request object for updating a secret key.
	UpdateCustomerSecretKeyDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateCustomerSecretKeyRequest wrapper for the UpdateCustomerSecretKey operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateCustomerSecretKey.go.html to see an example of how to use UpdateCustomerSecretKeyRequest.

func (UpdateCustomerSecretKeyRequest) BinaryRequestBody ¶

func (request UpdateCustomerSecretKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateCustomerSecretKeyRequest) HTTPRequest ¶

func (request UpdateCustomerSecretKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateCustomerSecretKeyRequest) RetryPolicy ¶

func (request UpdateCustomerSecretKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateCustomerSecretKeyRequest) String ¶

func (request UpdateCustomerSecretKeyRequest) String() string

func (UpdateCustomerSecretKeyRequest) ValidateEnumValue ¶

func (request UpdateCustomerSecretKeyRequest) 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

type UpdateCustomerSecretKeyResponse ¶

type UpdateCustomerSecretKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CustomerSecretKeySummary instance
	CustomerSecretKeySummary `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateCustomerSecretKeyResponse wrapper for the UpdateCustomerSecretKey operation

func (UpdateCustomerSecretKeyResponse) HTTPResponse ¶

func (response UpdateCustomerSecretKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateCustomerSecretKeyResponse) String ¶

func (response UpdateCustomerSecretKeyResponse) String() string

type UpdateDomainDetails ¶

type UpdateDomainDetails struct {

	// The identity domain description. You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// The mutable display name of the identity domain.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Indicates whether the identity domain is hidden on the sign-in screen or not.
	IsHiddenOnLogin *bool `mandatory:"false" json:"isHiddenOnLogin"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDomainDetails (For tenancies that support identity domains) Update identity domain details.

func (UpdateDomainDetails) String ¶

func (m UpdateDomainDetails) String() string

func (UpdateDomainDetails) ValidateEnumValue ¶

func (m UpdateDomainDetails) 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

type UpdateDomainRequest ¶

type UpdateDomainRequest struct {

	// The OCID of the identity domain.
	DomainId *string `mandatory:"true" contributesTo:"path" name:"domainId"`

	// Request object for updating the identity domain.
	UpdateDomainDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateDomainRequest wrapper for the UpdateDomain operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateDomain.go.html to see an example of how to use UpdateDomainRequest.

func (UpdateDomainRequest) BinaryRequestBody ¶

func (request UpdateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDomainRequest) HTTPRequest ¶

func (request UpdateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDomainRequest) RetryPolicy ¶

func (request UpdateDomainRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDomainRequest) String ¶

func (request UpdateDomainRequest) String() string

func (UpdateDomainRequest) ValidateEnumValue ¶

func (request UpdateDomainRequest) 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

type UpdateDomainResponse ¶

type UpdateDomainResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

UpdateDomainResponse wrapper for the UpdateDomain operation

func (UpdateDomainResponse) HTTPResponse ¶

func (response UpdateDomainResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDomainResponse) String ¶

func (response UpdateDomainResponse) String() string

type UpdateDynamicGroupDetails ¶

type UpdateDynamicGroupDetails struct {

	// The description you assign to the dynamic group. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// The matching rule to dynamically match an instance certificate to this dynamic group.
	// For rule syntax, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/dynamicgroups/managingdynamicgroups.htm).
	MatchingRule *string `mandatory:"false" json:"matchingRule"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDynamicGroupDetails Properties for updating a dynamic group.

func (UpdateDynamicGroupDetails) String ¶

func (m UpdateDynamicGroupDetails) String() string

func (UpdateDynamicGroupDetails) ValidateEnumValue ¶

func (m UpdateDynamicGroupDetails) 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

type UpdateDynamicGroupRequest ¶

type UpdateDynamicGroupRequest struct {

	// The OCID of the dynamic group.
	DynamicGroupId *string `mandatory:"true" contributesTo:"path" name:"dynamicGroupId"`

	// Request object for updating an dynamic group.
	UpdateDynamicGroupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateDynamicGroupRequest wrapper for the UpdateDynamicGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateDynamicGroup.go.html to see an example of how to use UpdateDynamicGroupRequest.

func (UpdateDynamicGroupRequest) BinaryRequestBody ¶

func (request UpdateDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDynamicGroupRequest) HTTPRequest ¶

func (request UpdateDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDynamicGroupRequest) RetryPolicy ¶

func (request UpdateDynamicGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDynamicGroupRequest) String ¶

func (request UpdateDynamicGroupRequest) String() string

func (UpdateDynamicGroupRequest) ValidateEnumValue ¶

func (request UpdateDynamicGroupRequest) 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

type UpdateDynamicGroupResponse ¶

type UpdateDynamicGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DynamicGroup instance
	DynamicGroup `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateDynamicGroupResponse wrapper for the UpdateDynamicGroup operation

func (UpdateDynamicGroupResponse) HTTPResponse ¶

func (response UpdateDynamicGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDynamicGroupResponse) String ¶

func (response UpdateDynamicGroupResponse) String() string

type UpdateGroupDetails ¶

type UpdateGroupDetails struct {

	// The description you assign to the group. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateGroupDetails The representation of UpdateGroupDetails

func (UpdateGroupDetails) String ¶

func (m UpdateGroupDetails) String() string

func (UpdateGroupDetails) ValidateEnumValue ¶

func (m UpdateGroupDetails) 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

type UpdateGroupRequest ¶

type UpdateGroupRequest struct {

	// The OCID of the group.
	GroupId *string `mandatory:"true" contributesTo:"path" name:"groupId"`

	// Request object for updating a group.
	UpdateGroupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateGroupRequest wrapper for the UpdateGroup operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateGroup.go.html to see an example of how to use UpdateGroupRequest.

func (UpdateGroupRequest) BinaryRequestBody ¶

func (request UpdateGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateGroupRequest) HTTPRequest ¶

func (request UpdateGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateGroupRequest) RetryPolicy ¶

func (request UpdateGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateGroupRequest) String ¶

func (request UpdateGroupRequest) String() string

func (UpdateGroupRequest) ValidateEnumValue ¶

func (request UpdateGroupRequest) 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

type UpdateGroupResponse ¶

type UpdateGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Group instance
	Group `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateGroupResponse wrapper for the UpdateGroup operation

func (UpdateGroupResponse) HTTPResponse ¶

func (response UpdateGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateGroupResponse) String ¶

func (response UpdateGroupResponse) String() string

type UpdateIdentityProviderDetails ¶

type UpdateIdentityProviderDetails interface {

	// The description you assign to the `IdentityProvider`. Does not have to
	// be unique, and it's changeable.
	GetDescription() *string

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

UpdateIdentityProviderDetails The representation of UpdateIdentityProviderDetails

type UpdateIdentityProviderDetailsProtocolEnum ¶

type UpdateIdentityProviderDetailsProtocolEnum string

UpdateIdentityProviderDetailsProtocolEnum Enum with underlying type: string

const (
	UpdateIdentityProviderDetailsProtocolSaml2 UpdateIdentityProviderDetailsProtocolEnum = "SAML2"
)

Set of constants representing the allowable values for UpdateIdentityProviderDetailsProtocolEnum

func GetMappingUpdateIdentityProviderDetailsProtocolEnum ¶

func GetMappingUpdateIdentityProviderDetailsProtocolEnum(val string) (UpdateIdentityProviderDetailsProtocolEnum, bool)

GetMappingUpdateIdentityProviderDetailsProtocolEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUpdateIdentityProviderDetailsProtocolEnumValues ¶

func GetUpdateIdentityProviderDetailsProtocolEnumValues() []UpdateIdentityProviderDetailsProtocolEnum

GetUpdateIdentityProviderDetailsProtocolEnumValues Enumerates the set of values for UpdateIdentityProviderDetailsProtocolEnum

type UpdateIdentityProviderRequest ¶

type UpdateIdentityProviderRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// Request object for updating a identity provider.
	UpdateIdentityProviderDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateIdentityProviderRequest wrapper for the UpdateIdentityProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateIdentityProvider.go.html to see an example of how to use UpdateIdentityProviderRequest.

func (UpdateIdentityProviderRequest) BinaryRequestBody ¶

func (request UpdateIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateIdentityProviderRequest) HTTPRequest ¶

func (request UpdateIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateIdentityProviderRequest) RetryPolicy ¶

func (request UpdateIdentityProviderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateIdentityProviderRequest) String ¶

func (request UpdateIdentityProviderRequest) String() string

func (UpdateIdentityProviderRequest) ValidateEnumValue ¶

func (request UpdateIdentityProviderRequest) 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

type UpdateIdentityProviderResponse ¶

type UpdateIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IdentityProvider instance
	IdentityProvider `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateIdentityProviderResponse wrapper for the UpdateIdentityProvider operation

func (UpdateIdentityProviderResponse) HTTPResponse ¶

func (response UpdateIdentityProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateIdentityProviderResponse) String ¶

func (response UpdateIdentityProviderResponse) String() string

type UpdateIdpGroupMappingDetails ¶

type UpdateIdpGroupMappingDetails struct {

	// The idp group name.
	IdpGroupName *string `mandatory:"false" json:"idpGroupName"`

	// The OCID of the group.
	GroupId *string `mandatory:"false" json:"groupId"`
}

UpdateIdpGroupMappingDetails The representation of UpdateIdpGroupMappingDetails

func (UpdateIdpGroupMappingDetails) String ¶

func (UpdateIdpGroupMappingDetails) ValidateEnumValue ¶

func (m UpdateIdpGroupMappingDetails) 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

type UpdateIdpGroupMappingRequest ¶

type UpdateIdpGroupMappingRequest struct {

	// The OCID of the identity provider.
	IdentityProviderId *string `mandatory:"true" contributesTo:"path" name:"identityProviderId"`

	// The OCID of the group mapping.
	MappingId *string `mandatory:"true" contributesTo:"path" name:"mappingId"`

	// Request object for updating an identity provider group mapping
	UpdateIdpGroupMappingDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateIdpGroupMappingRequest wrapper for the UpdateIdpGroupMapping operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateIdpGroupMapping.go.html to see an example of how to use UpdateIdpGroupMappingRequest.

func (UpdateIdpGroupMappingRequest) BinaryRequestBody ¶

func (request UpdateIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateIdpGroupMappingRequest) HTTPRequest ¶

func (request UpdateIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateIdpGroupMappingRequest) RetryPolicy ¶

func (request UpdateIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateIdpGroupMappingRequest) String ¶

func (request UpdateIdpGroupMappingRequest) String() string

func (UpdateIdpGroupMappingRequest) ValidateEnumValue ¶

func (request UpdateIdpGroupMappingRequest) 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

type UpdateIdpGroupMappingResponse ¶

type UpdateIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IdpGroupMapping instance
	IdpGroupMapping `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateIdpGroupMappingResponse wrapper for the UpdateIdpGroupMapping operation

func (UpdateIdpGroupMappingResponse) HTTPResponse ¶

func (response UpdateIdpGroupMappingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateIdpGroupMappingResponse) String ¶

func (response UpdateIdpGroupMappingResponse) String() string

type UpdateNetworkSourceDetails ¶

type UpdateNetworkSourceDetails struct {

	// The description you assign to the network source. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// A list of allowed public IP addresses and CIDR ranges.
	PublicSourceList []string `mandatory:"false" json:"publicSourceList"`

	// A list of allowed VCN OCID and IP range pairs.
	// Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]`
	VirtualSourceList []NetworkSourcesVirtualSourceList `mandatory:"false" json:"virtualSourceList"`

	// -- The services attribute has no effect and is reserved for use by Oracle. --
	Services []string `mandatory:"false" json:"services"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateNetworkSourceDetails The representation of UpdateNetworkSourceDetails

func (UpdateNetworkSourceDetails) String ¶

func (UpdateNetworkSourceDetails) ValidateEnumValue ¶

func (m UpdateNetworkSourceDetails) 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

type UpdateNetworkSourceRequest ¶

type UpdateNetworkSourceRequest struct {

	// The OCID of the network source.
	NetworkSourceId *string `mandatory:"true" contributesTo:"path" name:"networkSourceId"`

	// Request object for updating a network source.
	UpdateNetworkSourceDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateNetworkSourceRequest wrapper for the UpdateNetworkSource operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateNetworkSource.go.html to see an example of how to use UpdateNetworkSourceRequest.

func (UpdateNetworkSourceRequest) BinaryRequestBody ¶

func (request UpdateNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateNetworkSourceRequest) HTTPRequest ¶

func (request UpdateNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateNetworkSourceRequest) RetryPolicy ¶

func (request UpdateNetworkSourceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateNetworkSourceRequest) String ¶

func (request UpdateNetworkSourceRequest) String() string

func (UpdateNetworkSourceRequest) ValidateEnumValue ¶

func (request UpdateNetworkSourceRequest) 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

type UpdateNetworkSourceResponse ¶

type UpdateNetworkSourceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The NetworkSources instance
	NetworkSources `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateNetworkSourceResponse wrapper for the UpdateNetworkSource operation

func (UpdateNetworkSourceResponse) HTTPResponse ¶

func (response UpdateNetworkSourceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateNetworkSourceResponse) String ¶

func (response UpdateNetworkSourceResponse) String() string

type UpdateOAuth2ClientCredentialDetails ¶

type UpdateOAuth2ClientCredentialDetails struct {

	// Description of the oauth credential to help user differentiate them.
	Description *string `mandatory:"true" json:"description"`

	// Allowed scopes for the given oauth credential.
	Scopes []FullyQualifiedScope `mandatory:"true" json:"scopes"`

	// Indicate if the password to be reset or not in the update.
	IsResetPassword *bool `mandatory:"false" json:"isResetPassword"`
}

UpdateOAuth2ClientCredentialDetails The representation of UpdateOAuth2ClientCredentialDetails

func (UpdateOAuth2ClientCredentialDetails) String ¶

func (UpdateOAuth2ClientCredentialDetails) ValidateEnumValue ¶

func (m UpdateOAuth2ClientCredentialDetails) 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

type UpdateOAuthClientCredentialRequest ¶

type UpdateOAuthClientCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The ID of the Oauth credential.
	Oauth2ClientCredentialId *string `mandatory:"true" contributesTo:"path" name:"oauth2ClientCredentialId"`

	// Request object containing the information required to generate an Oauth token.
	UpdateOAuth2ClientCredentialDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateOAuthClientCredentialRequest wrapper for the UpdateOAuthClientCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateOAuthClientCredential.go.html to see an example of how to use UpdateOAuthClientCredentialRequest.

func (UpdateOAuthClientCredentialRequest) BinaryRequestBody ¶

func (request UpdateOAuthClientCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateOAuthClientCredentialRequest) HTTPRequest ¶

func (request UpdateOAuthClientCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateOAuthClientCredentialRequest) RetryPolicy ¶

func (request UpdateOAuthClientCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateOAuthClientCredentialRequest) String ¶

func (request UpdateOAuthClientCredentialRequest) String() string

func (UpdateOAuthClientCredentialRequest) ValidateEnumValue ¶

func (request UpdateOAuthClientCredentialRequest) 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

type UpdateOAuthClientCredentialResponse ¶

type UpdateOAuthClientCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OAuth2ClientCredential instance
	OAuth2ClientCredential `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateOAuthClientCredentialResponse wrapper for the UpdateOAuthClientCredential operation

func (UpdateOAuthClientCredentialResponse) HTTPResponse ¶

func (response UpdateOAuthClientCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateOAuthClientCredentialResponse) String ¶

func (response UpdateOAuthClientCredentialResponse) String() string

type UpdatePolicyDetails ¶

type UpdatePolicyDetails struct {

	// The description you assign to the policy. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// An array of policy statements written in the policy language. See
	// How Policies Work (https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm) and
	// Common Policies (https://docs.cloud.oracle.com/Content/Identity/policiescommon/commonpolicies.htm).
	Statements []string `mandatory:"false" json:"statements"`

	// The version of the policy. If null or set to an empty string, when a request comes in for authorization, the
	// policy will be evaluated according to the current behavior of the services at that moment. If set to a particular
	// date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.
	VersionDate *common.SDKDate `mandatory:"false" json:"versionDate"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdatePolicyDetails The representation of UpdatePolicyDetails

func (UpdatePolicyDetails) String ¶

func (m UpdatePolicyDetails) String() string

func (UpdatePolicyDetails) ValidateEnumValue ¶

func (m UpdatePolicyDetails) 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

type UpdatePolicyRequest ¶

type UpdatePolicyRequest struct {

	// The OCID of the policy.
	PolicyId *string `mandatory:"true" contributesTo:"path" name:"policyId"`

	// Request object for updating a policy.
	UpdatePolicyDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdatePolicyRequest wrapper for the UpdatePolicy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdatePolicy.go.html to see an example of how to use UpdatePolicyRequest.

func (UpdatePolicyRequest) BinaryRequestBody ¶

func (request UpdatePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdatePolicyRequest) HTTPRequest ¶

func (request UpdatePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdatePolicyRequest) RetryPolicy ¶

func (request UpdatePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdatePolicyRequest) String ¶

func (request UpdatePolicyRequest) String() string

func (UpdatePolicyRequest) ValidateEnumValue ¶

func (request UpdatePolicyRequest) 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

type UpdatePolicyResponse ¶

type UpdatePolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Policy instance
	Policy `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdatePolicyResponse wrapper for the UpdatePolicy operation

func (UpdatePolicyResponse) HTTPResponse ¶

func (response UpdatePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdatePolicyResponse) String ¶

func (response UpdatePolicyResponse) String() string

type UpdateSaml2IdentityProviderDetails ¶

type UpdateSaml2IdentityProviderDetails struct {

	// The description you assign to the `IdentityProvider`. Does not have to
	// be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The URL for retrieving the identity provider's metadata,
	// which contains information required for federating.
	MetadataUrl *string `mandatory:"false" json:"metadataUrl"`

	// The XML that contains the information required for federating.
	Metadata *string `mandatory:"false" json:"metadata"`

	// Extra name value pairs associated with this identity provider.
	// Example: `{"clientId": "app_sf3kdjf3"}`
	FreeformAttributes map[string]string `mandatory:"false" json:"freeformAttributes"`
}

UpdateSaml2IdentityProviderDetails The representation of UpdateSaml2IdentityProviderDetails

func (UpdateSaml2IdentityProviderDetails) GetDefinedTags ¶

func (m UpdateSaml2IdentityProviderDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateSaml2IdentityProviderDetails) GetDescription ¶

func (m UpdateSaml2IdentityProviderDetails) GetDescription() *string

GetDescription returns Description

func (UpdateSaml2IdentityProviderDetails) GetFreeformTags ¶

func (m UpdateSaml2IdentityProviderDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateSaml2IdentityProviderDetails) MarshalJSON ¶

func (m UpdateSaml2IdentityProviderDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateSaml2IdentityProviderDetails) String ¶

func (UpdateSaml2IdentityProviderDetails) ValidateEnumValue ¶

func (m UpdateSaml2IdentityProviderDetails) 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

type UpdateSmtpCredentialDetails ¶

type UpdateSmtpCredentialDetails struct {

	// The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`
}

UpdateSmtpCredentialDetails The representation of UpdateSmtpCredentialDetails

func (UpdateSmtpCredentialDetails) String ¶

func (UpdateSmtpCredentialDetails) ValidateEnumValue ¶

func (m UpdateSmtpCredentialDetails) 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

type UpdateSmtpCredentialRequest ¶

type UpdateSmtpCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the SMTP credential.
	SmtpCredentialId *string `mandatory:"true" contributesTo:"path" name:"smtpCredentialId"`

	// Request object for updating a SMTP credential.
	UpdateSmtpCredentialDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateSmtpCredentialRequest wrapper for the UpdateSmtpCredential operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateSmtpCredential.go.html to see an example of how to use UpdateSmtpCredentialRequest.

func (UpdateSmtpCredentialRequest) BinaryRequestBody ¶

func (request UpdateSmtpCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSmtpCredentialRequest) HTTPRequest ¶

func (request UpdateSmtpCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSmtpCredentialRequest) RetryPolicy ¶

func (request UpdateSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSmtpCredentialRequest) String ¶

func (request UpdateSmtpCredentialRequest) String() string

func (UpdateSmtpCredentialRequest) ValidateEnumValue ¶

func (request UpdateSmtpCredentialRequest) 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

type UpdateSmtpCredentialResponse ¶

type UpdateSmtpCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SmtpCredentialSummary instance
	SmtpCredentialSummary `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateSmtpCredentialResponse wrapper for the UpdateSmtpCredential operation

func (UpdateSmtpCredentialResponse) HTTPResponse ¶

func (response UpdateSmtpCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSmtpCredentialResponse) String ¶

func (response UpdateSmtpCredentialResponse) String() string

type UpdateStateDetails ¶

type UpdateStateDetails struct {

	// Update state to blocked or unblocked. Only "false" is supported (for changing the state to unblocked).
	Blocked *bool `mandatory:"false" json:"blocked"`
}

UpdateStateDetails The representation of UpdateStateDetails

func (UpdateStateDetails) String ¶

func (m UpdateStateDetails) String() string

func (UpdateStateDetails) ValidateEnumValue ¶

func (m UpdateStateDetails) 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

type UpdateSwiftPasswordDetails ¶

type UpdateSwiftPasswordDetails struct {

	// The description you assign to the Swift password. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`
}

UpdateSwiftPasswordDetails The representation of UpdateSwiftPasswordDetails

func (UpdateSwiftPasswordDetails) String ¶

func (UpdateSwiftPasswordDetails) ValidateEnumValue ¶

func (m UpdateSwiftPasswordDetails) 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

type UpdateSwiftPasswordRequest ¶

type UpdateSwiftPasswordRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the Swift password.
	SwiftPasswordId *string `mandatory:"true" contributesTo:"path" name:"swiftPasswordId"`

	// Request object for updating a Swift password.
	UpdateSwiftPasswordDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateSwiftPasswordRequest wrapper for the UpdateSwiftPassword operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateSwiftPassword.go.html to see an example of how to use UpdateSwiftPasswordRequest.

func (UpdateSwiftPasswordRequest) BinaryRequestBody ¶

func (request UpdateSwiftPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSwiftPasswordRequest) HTTPRequest ¶

func (request UpdateSwiftPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSwiftPasswordRequest) RetryPolicy ¶

func (request UpdateSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSwiftPasswordRequest) String ¶

func (request UpdateSwiftPasswordRequest) String() string

func (UpdateSwiftPasswordRequest) ValidateEnumValue ¶

func (request UpdateSwiftPasswordRequest) 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

type UpdateSwiftPasswordResponse ¶

type UpdateSwiftPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SwiftPassword instance
	SwiftPassword `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateSwiftPasswordResponse wrapper for the UpdateSwiftPassword operation

func (UpdateSwiftPasswordResponse) HTTPResponse ¶

func (response UpdateSwiftPasswordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSwiftPasswordResponse) String ¶

func (response UpdateSwiftPasswordResponse) String() string

type UpdateTagDefaultDetails ¶

type UpdateTagDefaultDetails struct {

	// The default value for the tag definition. This will be applied to all resources created in the Compartment.
	Value *string `mandatory:"true" json:"value"`

	// If you specify that a value is required, a value is set during resource creation (either by
	// the user creating the resource or another tag defualt). If no value is set, resource
	// creation is blocked.
	// * If the `isRequired` flag is set to "true", the value is set during resource creation.
	// * If the `isRequired` flag is set to "false", the value you enter is set during resource creation.
	// Example: `false`
	IsRequired *bool `mandatory:"false" json:"isRequired"`
}

UpdateTagDefaultDetails The representation of UpdateTagDefaultDetails

func (UpdateTagDefaultDetails) String ¶

func (m UpdateTagDefaultDetails) String() string

func (UpdateTagDefaultDetails) ValidateEnumValue ¶

func (m UpdateTagDefaultDetails) 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

type UpdateTagDefaultRequest ¶

type UpdateTagDefaultRequest struct {

	// The OCID of the tag default.
	TagDefaultId *string `mandatory:"true" contributesTo:"path" name:"tagDefaultId"`

	// Request object for updating a tag default.
	UpdateTagDefaultDetails `contributesTo:"body"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateTagDefaultRequest wrapper for the UpdateTagDefault operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTagDefault.go.html to see an example of how to use UpdateTagDefaultRequest.

func (UpdateTagDefaultRequest) BinaryRequestBody ¶

func (request UpdateTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateTagDefaultRequest) HTTPRequest ¶

func (request UpdateTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTagDefaultRequest) RetryPolicy ¶

func (request UpdateTagDefaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTagDefaultRequest) String ¶

func (request UpdateTagDefaultRequest) String() string

func (UpdateTagDefaultRequest) ValidateEnumValue ¶

func (request UpdateTagDefaultRequest) 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

type UpdateTagDefaultResponse ¶

type UpdateTagDefaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagDefault instance
	TagDefault `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateTagDefaultResponse wrapper for the UpdateTagDefault operation

func (UpdateTagDefaultResponse) HTTPResponse ¶

func (response UpdateTagDefaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTagDefaultResponse) String ¶

func (response UpdateTagDefaultResponse) String() string

type UpdateTagDetails ¶

type UpdateTagDetails struct {

	// The description you assign to the tag during creation.
	Description *string `mandatory:"false" json:"description"`

	// Whether the tag is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Indicates whether the tag is enabled for cost tracking.
	IsCostTracking *bool `mandatory:"false" json:"isCostTracking"`

	Validator BaseTagDefinitionValidator `mandatory:"false" json:"validator"`
}

UpdateTagDetails The representation of UpdateTagDetails

func (UpdateTagDetails) String ¶

func (m UpdateTagDetails) String() string

func (*UpdateTagDetails) UnmarshalJSON ¶

func (m *UpdateTagDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (UpdateTagDetails) ValidateEnumValue ¶

func (m UpdateTagDetails) 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

type UpdateTagNamespaceDetails ¶

type UpdateTagNamespaceDetails struct {

	// The description you assign to the tag namespace.
	Description *string `mandatory:"false" json:"description"`

	// Whether the tag namespace is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateTagNamespaceDetails The representation of UpdateTagNamespaceDetails

func (UpdateTagNamespaceDetails) String ¶

func (m UpdateTagNamespaceDetails) String() string

func (UpdateTagNamespaceDetails) ValidateEnumValue ¶

func (m UpdateTagNamespaceDetails) 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

type UpdateTagNamespaceRequest ¶

type UpdateTagNamespaceRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// Request object for updating a namespace.
	UpdateTagNamespaceDetails `contributesTo:"body"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

UpdateTagNamespaceRequest wrapper for the UpdateTagNamespace operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTagNamespace.go.html to see an example of how to use UpdateTagNamespaceRequest.

func (UpdateTagNamespaceRequest) BinaryRequestBody ¶

func (request UpdateTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateTagNamespaceRequest) HTTPRequest ¶

func (request UpdateTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTagNamespaceRequest) RetryPolicy ¶

func (request UpdateTagNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTagNamespaceRequest) String ¶

func (request UpdateTagNamespaceRequest) String() string

func (UpdateTagNamespaceRequest) ValidateEnumValue ¶

func (request UpdateTagNamespaceRequest) 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

type UpdateTagNamespaceResponse ¶

type UpdateTagNamespaceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagNamespace instance
	TagNamespace `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"`
}

UpdateTagNamespaceResponse wrapper for the UpdateTagNamespace operation

func (UpdateTagNamespaceResponse) HTTPResponse ¶

func (response UpdateTagNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTagNamespaceResponse) String ¶

func (response UpdateTagNamespaceResponse) String() string

type UpdateTagRequest ¶

type UpdateTagRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// The name of the tag.
	TagName *string `mandatory:"true" contributesTo:"path" name:"tagName"`

	// Request object for updating a tag.
	UpdateTagDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Whether to override locks (if any exist).
	IsLockOverride *bool `mandatory:"false" contributesTo:"query" name:"isLockOverride"`

	// 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
}

UpdateTagRequest wrapper for the UpdateTag operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTag.go.html to see an example of how to use UpdateTagRequest.

func (UpdateTagRequest) BinaryRequestBody ¶

func (request UpdateTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateTagRequest) HTTPRequest ¶

func (request UpdateTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTagRequest) RetryPolicy ¶

func (request UpdateTagRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTagRequest) String ¶

func (request UpdateTagRequest) String() string

func (UpdateTagRequest) ValidateEnumValue ¶

func (request UpdateTagRequest) 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

type UpdateTagResponse ¶

type UpdateTagResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Tag instance
	Tag `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateTagResponse wrapper for the UpdateTag operation

func (UpdateTagResponse) HTTPResponse ¶

func (response UpdateTagResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTagResponse) String ¶

func (response UpdateTagResponse) String() string

type UpdateUserCapabilitiesDetails ¶

type UpdateUserCapabilitiesDetails struct {

	// Indicates if the user can log in to the console.
	CanUseConsolePassword *bool `mandatory:"false" json:"canUseConsolePassword"`

	// Indicates if the user can use API keys.
	CanUseApiKeys *bool `mandatory:"false" json:"canUseApiKeys"`

	// Indicates if the user can use SWIFT passwords / auth tokens.
	CanUseAuthTokens *bool `mandatory:"false" json:"canUseAuthTokens"`

	// Indicates if the user can use SMTP passwords.
	CanUseSmtpCredentials *bool `mandatory:"false" json:"canUseSmtpCredentials"`

	// Indicates if the user can use DB passwords.
	CanUseDBCredentials *bool `mandatory:"false" json:"canUseDBCredentials"`

	// Indicates if the user can use SigV4 symmetric keys.
	CanUseCustomerSecretKeys *bool `mandatory:"false" json:"canUseCustomerSecretKeys"`

	// Indicates if the user can use OAuth2 credentials and tokens.
	CanUseOAuth2ClientCredentials *bool `mandatory:"false" json:"canUseOAuth2ClientCredentials"`
}

UpdateUserCapabilitiesDetails The representation of UpdateUserCapabilitiesDetails

func (UpdateUserCapabilitiesDetails) String ¶

func (UpdateUserCapabilitiesDetails) ValidateEnumValue ¶

func (m UpdateUserCapabilitiesDetails) 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

type UpdateUserCapabilitiesRequest ¶

type UpdateUserCapabilitiesRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for updating user capabilities.
	UpdateUserCapabilitiesDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateUserCapabilitiesRequest wrapper for the UpdateUserCapabilities operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUserCapabilities.go.html to see an example of how to use UpdateUserCapabilitiesRequest.

func (UpdateUserCapabilitiesRequest) BinaryRequestBody ¶

func (request UpdateUserCapabilitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateUserCapabilitiesRequest) HTTPRequest ¶

func (request UpdateUserCapabilitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUserCapabilitiesRequest) RetryPolicy ¶

func (request UpdateUserCapabilitiesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateUserCapabilitiesRequest) String ¶

func (request UpdateUserCapabilitiesRequest) String() string

func (UpdateUserCapabilitiesRequest) ValidateEnumValue ¶

func (request UpdateUserCapabilitiesRequest) 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

type UpdateUserCapabilitiesResponse ¶

type UpdateUserCapabilitiesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateUserCapabilitiesResponse wrapper for the UpdateUserCapabilities operation

func (UpdateUserCapabilitiesResponse) HTTPResponse ¶

func (response UpdateUserCapabilitiesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateUserCapabilitiesResponse) String ¶

func (response UpdateUserCapabilitiesResponse) String() string

type UpdateUserDetails ¶

type UpdateUserDetails struct {

	// The description you assign to the user. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"false" json:"description"`

	// The email you assign to the user during creation. The email must be unique across all users in the tenancy.
	// (For tenancies that support identity domains) You must provide an email for each user.
	Email *string `mandatory:"false" json:"email"`

	// DB username of the DB credential. Has to be unique across the tenancy.
	DbUserName *string `mandatory:"false" json:"dbUserName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateUserDetails The representation of UpdateUserDetails

func (UpdateUserDetails) String ¶

func (m UpdateUserDetails) String() string

func (UpdateUserDetails) ValidateEnumValue ¶

func (m UpdateUserDetails) 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

type UpdateUserRequest ¶

type UpdateUserRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for updating a user.
	UpdateUserDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateUserRequest wrapper for the UpdateUser operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUser.go.html to see an example of how to use UpdateUserRequest.

func (UpdateUserRequest) BinaryRequestBody ¶

func (request UpdateUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateUserRequest) HTTPRequest ¶

func (request UpdateUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUserRequest) RetryPolicy ¶

func (request UpdateUserRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateUserRequest) String ¶

func (request UpdateUserRequest) String() string

func (UpdateUserRequest) ValidateEnumValue ¶

func (request UpdateUserRequest) 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

type UpdateUserResponse ¶

type UpdateUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateUserResponse wrapper for the UpdateUser operation

func (UpdateUserResponse) HTTPResponse ¶

func (response UpdateUserResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateUserResponse) String ¶

func (response UpdateUserResponse) String() string

type UpdateUserStateRequest ¶

type UpdateUserStateRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for updating a user state.
	UpdateStateDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateUserStateRequest wrapper for the UpdateUserState operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUserState.go.html to see an example of how to use UpdateUserStateRequest.

func (UpdateUserStateRequest) BinaryRequestBody ¶

func (request UpdateUserStateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateUserStateRequest) HTTPRequest ¶

func (request UpdateUserStateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUserStateRequest) RetryPolicy ¶

func (request UpdateUserStateRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateUserStateRequest) String ¶

func (request UpdateUserStateRequest) String() string

func (UpdateUserStateRequest) ValidateEnumValue ¶

func (request UpdateUserStateRequest) 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

type UpdateUserStateResponse ¶

type UpdateUserStateResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateUserStateResponse wrapper for the UpdateUserState operation

func (UpdateUserStateResponse) HTTPResponse ¶

func (response UpdateUserStateResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateUserStateResponse) String ¶

func (response UpdateUserStateResponse) String() string

type UploadApiKeyRequest ¶

type UploadApiKeyRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for uploading an API key for a user.
	CreateApiKeyDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

UploadApiKeyRequest wrapper for the UploadApiKey operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UploadApiKey.go.html to see an example of how to use UploadApiKeyRequest.

func (UploadApiKeyRequest) BinaryRequestBody ¶

func (request UploadApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UploadApiKeyRequest) HTTPRequest ¶

func (request UploadApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UploadApiKeyRequest) RetryPolicy ¶

func (request UploadApiKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UploadApiKeyRequest) String ¶

func (request UploadApiKeyRequest) String() string

func (UploadApiKeyRequest) ValidateEnumValue ¶

func (request UploadApiKeyRequest) 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

type UploadApiKeyResponse ¶

type UploadApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ApiKey instance
	ApiKey `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UploadApiKeyResponse wrapper for the UploadApiKey operation

func (UploadApiKeyResponse) HTTPResponse ¶

func (response UploadApiKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UploadApiKeyResponse) String ¶

func (response UploadApiKeyResponse) String() string

type User ¶

type User struct {

	// The OCID of the user.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the user.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the user during creation. This is the user's login for the Console.
	// The name must be unique across all users in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the user. Does not have to be unique, and it's changeable.
	// (For tenancies that support identity domains) You can have an empty description.
	Description *string `mandatory:"true" json:"description"`

	// Date and time the user was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState UserLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Flag indicates if MFA has been activated for the user.
	IsMfaActivated *bool `mandatory:"true" json:"isMfaActivated"`

	// The email address you assign to the user.
	// The email address must be unique across all users in the tenancy.
	// (For tenancies that support identity domains) The email address is required unless the requirement is disabled at the tenancy level.
	Email *string `mandatory:"false" json:"email"`

	// Whether the email address has been validated.
	EmailVerified *bool `mandatory:"false" json:"emailVerified"`

	// DB username of the DB credential. Has to be unique across the tenancy.
	DbUserName *string `mandatory:"false" json:"dbUserName"`

	// The OCID of the `IdentityProvider` this user belongs to.
	IdentityProviderId *string `mandatory:"false" json:"identityProviderId"`

	// Identifier of the user in the identity provider
	ExternalIdentifier *string `mandatory:"false" json:"externalIdentifier"`

	// Returned only if the user's `lifecycleState` is INACTIVE. A 16-bit value showing the reason why the user
	// is inactive:
	// - bit 0: SUSPENDED (reserved for future use)
	// - bit 1: DISABLED (reserved for future use)
	// - bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console)
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	Capabilities *UserCapabilities `mandatory:"false" json:"capabilities"`

	// The date and time of when the user most recently logged in the
	// format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`).
	// If there is no login history, this field is null.
	// For illustrative purposes, suppose we have a user who has logged in
	// at July 1st, 2020 at 1200 PST and logged out 30 minutes later.
	// They then login again on July 2nd, 2020 at 1500 PST.
	// Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`.
	// Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`.
	LastSuccessfulLoginTime *common.SDKTime `mandatory:"false" json:"lastSuccessfulLoginTime"`

	// The date and time of when the user most recently logged in the
	// format defined by RFC3339 (ex. `2016-08-25T21:10:29.600Z`).
	// If there is no login history, this field is null.
	// For illustrative purposes, suppose we have a user who has logged in
	// at July 1st, 2020 at 1200 PST and logged out 30 minutes later.
	// They then login again on July 2nd, 2020 at 1500 PST.
	// Their previousSuccessfulLoginTime would be `2020-07-01:19:00.000Z`.
	// Their lastSuccessfulLoginTime would be `2020-07-02:22:00.000Z`.
	PreviousSuccessfulLoginTime *common.SDKTime `mandatory:"false" json:"previousSuccessfulLoginTime"`
}

User An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials (ApiKey, UIPassword, SwiftPassword and AuthToken). For more information, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/usercred/usercredentials.htm)). End users of your application are not typically IAM Service users, but for tenancies that have identity domains, they might be. For conceptual information about users and other IAM Service components, see Overview of IAM (https://docs.cloud.oracle.com/Content/Identity/getstarted/identity-domains.htm). These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service. They are different from *federated users*, who authenticate themselves to the Oracle Cloud Infrastructure Console via an identity provider. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Get Started with Policies (https://docs.cloud.oracle.com/Content/Identity/policiesgs/get-started-with-policies.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (User) String ¶

func (m User) String() string

func (User) ValidateEnumValue ¶

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

type UserCapabilities ¶

type UserCapabilities struct {

	// Indicates if the user can log in to the console.
	CanUseConsolePassword *bool `mandatory:"false" json:"canUseConsolePassword"`

	// Indicates if the user can use API keys.
	CanUseApiKeys *bool `mandatory:"false" json:"canUseApiKeys"`

	// Indicates if the user can use SWIFT passwords / auth tokens.
	CanUseAuthTokens *bool `mandatory:"false" json:"canUseAuthTokens"`

	// Indicates if the user can use SMTP passwords.
	CanUseSmtpCredentials *bool `mandatory:"false" json:"canUseSmtpCredentials"`

	// Indicates if the user can use DB passwords.
	CanUseDbCredentials *bool `mandatory:"false" json:"canUseDbCredentials"`

	// Indicates if the user can use SigV4 symmetric keys.
	CanUseCustomerSecretKeys *bool `mandatory:"false" json:"canUseCustomerSecretKeys"`

	// Indicates if the user can use OAuth2 credentials and tokens.
	CanUseOAuth2ClientCredentials *bool `mandatory:"false" json:"canUseOAuth2ClientCredentials"`
}

UserCapabilities Properties indicating how the user is allowed to authenticate.

func (UserCapabilities) String ¶

func (m UserCapabilities) String() string

func (UserCapabilities) ValidateEnumValue ¶

func (m UserCapabilities) 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

type UserGroupMembership ¶

type UserGroupMembership struct {

	// The OCID of the membership.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the user, group, and membership object.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the group.
	GroupId *string `mandatory:"true" json:"groupId"`

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

	// Date and time the membership was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The membership's current state.  After creating a membership object, make sure its `lifecycleState` changes
	// from CREATING to ACTIVE before using it.
	LifecycleState UserGroupMembershipLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

UserGroupMembership An object that represents the membership of a user in a group. When you add a user to a group, the result is a `UserGroupMembership` with its own OCID. To remove a user from a group, you delete the `UserGroupMembership` object.

func (UserGroupMembership) String ¶

func (m UserGroupMembership) String() string

func (UserGroupMembership) ValidateEnumValue ¶

func (m UserGroupMembership) 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

type UserGroupMembershipLifecycleStateEnum ¶

type UserGroupMembershipLifecycleStateEnum string

UserGroupMembershipLifecycleStateEnum Enum with underlying type: string

const (
	UserGroupMembershipLifecycleStateCreating UserGroupMembershipLifecycleStateEnum = "CREATING"
	UserGroupMembershipLifecycleStateActive   UserGroupMembershipLifecycleStateEnum = "ACTIVE"
	UserGroupMembershipLifecycleStateInactive UserGroupMembershipLifecycleStateEnum = "INACTIVE"
	UserGroupMembershipLifecycleStateDeleting UserGroupMembershipLifecycleStateEnum = "DELETING"
	UserGroupMembershipLifecycleStateDeleted  UserGroupMembershipLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UserGroupMembershipLifecycleStateEnum

func GetMappingUserGroupMembershipLifecycleStateEnum ¶

func GetMappingUserGroupMembershipLifecycleStateEnum(val string) (UserGroupMembershipLifecycleStateEnum, bool)

GetMappingUserGroupMembershipLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUserGroupMembershipLifecycleStateEnumValues ¶

func GetUserGroupMembershipLifecycleStateEnumValues() []UserGroupMembershipLifecycleStateEnum

GetUserGroupMembershipLifecycleStateEnumValues Enumerates the set of values for UserGroupMembershipLifecycleStateEnum

type UserLifecycleStateEnum ¶

type UserLifecycleStateEnum string

UserLifecycleStateEnum Enum with underlying type: string

const (
	UserLifecycleStateCreating UserLifecycleStateEnum = "CREATING"
	UserLifecycleStateActive   UserLifecycleStateEnum = "ACTIVE"
	UserLifecycleStateInactive UserLifecycleStateEnum = "INACTIVE"
	UserLifecycleStateDeleting UserLifecycleStateEnum = "DELETING"
	UserLifecycleStateDeleted  UserLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UserLifecycleStateEnum

func GetMappingUserLifecycleStateEnum ¶

func GetMappingUserLifecycleStateEnum(val string) (UserLifecycleStateEnum, bool)

GetMappingUserLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUserLifecycleStateEnumValues ¶

func GetUserLifecycleStateEnumValues() []UserLifecycleStateEnum

GetUserLifecycleStateEnumValues Enumerates the set of values for UserLifecycleStateEnum

type WorkRequest ¶

type WorkRequest struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// An enum-like description of the type of work the work request is doing.
	OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment that contains the work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"false" json:"resources"`

	// The errors for work request.
	Errors []WorkRequestError `mandatory:"false" json:"errors"`

	// The logs for work request.
	Logs []WorkRequestLogEntry `mandatory:"false" json:"logs"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
}

WorkRequest The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

func (WorkRequest) String ¶

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue ¶

func (m WorkRequest) 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

type WorkRequestError ¶

type WorkRequestError struct {

	// A machine-usable code for the error that occured.
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the error happened, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

WorkRequestError The error entity.

func (WorkRequestError) String ¶

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue ¶

func (m WorkRequestError) 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

type WorkRequestLogEntry ¶

type WorkRequestLogEntry struct {

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the log was written, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

WorkRequestLogEntry The log entity.

func (WorkRequestLogEntry) String ¶

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue ¶

func (m WorkRequestLogEntry) 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

type WorkRequestOperationTypeEnum ¶

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string

const (
	WorkRequestOperationTypeCompartment   WorkRequestOperationTypeEnum = "DELETE_COMPARTMENT"
	WorkRequestOperationTypeTagDefinition WorkRequestOperationTypeEnum = "DELETE_TAG_DEFINITION"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetMappingWorkRequestOperationTypeEnum ¶

func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)

GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestOperationTypeEnumValues ¶

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource ¶

type WorkRequestResource struct {

	// The resource identifier the work request affects.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The resource type the work request is affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource was affected by the work tracked by the work request.
	ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

	// The URI path that the user can do a GET on to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`
}

WorkRequestResource The resource entity.

func (WorkRequestResource) String ¶

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue ¶

func (m WorkRequestResource) 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

type WorkRequestResourceActionTypeEnum ¶

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string

const (
	WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
	WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
	WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
	WorkRequestResourceActionTypeRelated    WorkRequestResourceActionTypeEnum = "RELATED"
	WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
	WorkRequestResourceActionTypeFailed     WorkRequestResourceActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetMappingWorkRequestResourceActionTypeEnum ¶

func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)

GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceActionTypeEnumValues ¶

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum ¶

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

const (
	WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
	WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
	WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetMappingWorkRequestStatusEnum ¶

func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)

GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestStatusEnumValues ¶

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary ¶

type WorkRequestSummary struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// An enum-like description of the type of work the work request is doing.
	OperationType WorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment that contains the work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"false" json:"resources"`

	// The errors for work request.
	Errors []WorkRequestError `mandatory:"false" json:"errors"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
}

WorkRequestSummary The work request summary. Tracks the status of the asynchronous operation.

func (WorkRequestSummary) String ¶

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue ¶

func (m WorkRequestSummary) 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

type WorkRequestSummaryOperationTypeEnum ¶

type WorkRequestSummaryOperationTypeEnum string

WorkRequestSummaryOperationTypeEnum Enum with underlying type: string

const (
	WorkRequestSummaryOperationTypeCompartment   WorkRequestSummaryOperationTypeEnum = "DELETE_COMPARTMENT"
	WorkRequestSummaryOperationTypeTagDefinition WorkRequestSummaryOperationTypeEnum = "DELETE_TAG_DEFINITION"
)

Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum

func GetMappingWorkRequestSummaryOperationTypeEnum ¶

func GetMappingWorkRequestSummaryOperationTypeEnum(val string) (WorkRequestSummaryOperationTypeEnum, bool)

GetMappingWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestSummaryOperationTypeEnumValues ¶

func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum

GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum

type WorkRequestSummaryStatusEnum ¶

type WorkRequestSummaryStatusEnum string

WorkRequestSummaryStatusEnum Enum with underlying type: string

const (
	WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
	WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
	WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
	WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
	WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
	WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

func GetMappingWorkRequestSummaryStatusEnum ¶

func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)

GetMappingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestSummaryStatusEnumValues ¶

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum

Source Files ¶

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL