func GetAddLockDetailsTypeEnumStringValues() []string
GetAddLockDetailsTypeEnumStringValues Enumerates the set of values in String for AddLockDetailsTypeEnum
func GetApiKeyLifecycleStateEnumStringValues() []string
GetApiKeyLifecycleStateEnumStringValues Enumerates the set of values in String for ApiKeyLifecycleStateEnum
func GetAuthTokenLifecycleStateEnumStringValues() []string
GetAuthTokenLifecycleStateEnumStringValues Enumerates the set of values in String for AuthTokenLifecycleStateEnum
func GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues() []string
GetBaseTagDefinitionValidatorValidatorTypeEnumStringValues Enumerates the set of values in String for BaseTagDefinitionValidatorValidatorTypeEnum
func GetBulkEditOperationDetailsOperationTypeEnumStringValues() []string
GetBulkEditOperationDetailsOperationTypeEnumStringValues Enumerates the set of values in String for BulkEditOperationDetailsOperationTypeEnum
func GetCompartmentLifecycleStateEnumStringValues() []string
GetCompartmentLifecycleStateEnumStringValues Enumerates the set of values in String for CompartmentLifecycleStateEnum
func GetCreateIdentityProviderDetailsProductTypeEnumStringValues() []string
GetCreateIdentityProviderDetailsProductTypeEnumStringValues Enumerates the set of values in String for CreateIdentityProviderDetailsProductTypeEnum
func GetCreateIdentityProviderDetailsProtocolEnumStringValues() []string
GetCreateIdentityProviderDetailsProtocolEnumStringValues Enumerates the set of values in String for CreateIdentityProviderDetailsProtocolEnum
func GetCustomerSecretKeyLifecycleStateEnumStringValues() []string
GetCustomerSecretKeyLifecycleStateEnumStringValues Enumerates the set of values in String for CustomerSecretKeyLifecycleStateEnum
func GetCustomerSecretKeySummaryLifecycleStateEnumStringValues() []string
GetCustomerSecretKeySummaryLifecycleStateEnumStringValues Enumerates the set of values in String for CustomerSecretKeySummaryLifecycleStateEnum
func GetDbCredentialLifecycleStateEnumStringValues() []string
GetDbCredentialLifecycleStateEnumStringValues Enumerates the set of values in String for DbCredentialLifecycleStateEnum
func GetDomainLifecycleDetailsEnumStringValues() []string
GetDomainLifecycleDetailsEnumStringValues Enumerates the set of values in String for DomainLifecycleDetailsEnum
func GetDomainLifecycleStateEnumStringValues() []string
GetDomainLifecycleStateEnumStringValues Enumerates the set of values in String for DomainLifecycleStateEnum
func GetDomainSummaryLifecycleDetailsEnumStringValues() []string
GetDomainSummaryLifecycleDetailsEnumStringValues Enumerates the set of values in String for DomainSummaryLifecycleDetailsEnum
func GetDomainTypeEnumStringValues() []string
GetDomainTypeEnumStringValues Enumerates the set of values in String for DomainTypeEnum
func GetDynamicGroupLifecycleStateEnumStringValues() []string
GetDynamicGroupLifecycleStateEnumStringValues Enumerates the set of values in String for DynamicGroupLifecycleStateEnum
func GetGroupLifecycleStateEnumStringValues() []string
GetGroupLifecycleStateEnumStringValues Enumerates the set of values in String for GroupLifecycleStateEnum
func GetIamWorkRequestOperationTypeEnumStringValues() []string
GetIamWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for IamWorkRequestOperationTypeEnum
func GetIamWorkRequestResourceActionTypeEnumStringValues() []string
GetIamWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for IamWorkRequestResourceActionTypeEnum
func GetIamWorkRequestStatusEnumStringValues() []string
GetIamWorkRequestStatusEnumStringValues Enumerates the set of values in String for IamWorkRequestStatusEnum
func GetIamWorkRequestSummaryOperationTypeEnumStringValues() []string
GetIamWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for IamWorkRequestSummaryOperationTypeEnum
func GetIamWorkRequestSummaryStatusEnumStringValues() []string
GetIamWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for IamWorkRequestSummaryStatusEnum
func GetIdentityProviderLifecycleStateEnumStringValues() []string
GetIdentityProviderLifecycleStateEnumStringValues Enumerates the set of values in String for IdentityProviderLifecycleStateEnum
func GetIdpGroupMappingLifecycleStateEnumStringValues() []string
GetIdpGroupMappingLifecycleStateEnumStringValues Enumerates the set of values in String for IdpGroupMappingLifecycleStateEnum
func GetListBulkActionResourceTypesBulkActionTypeEnumStringValues() []string
GetListBulkActionResourceTypesBulkActionTypeEnumStringValues Enumerates the set of values in String for ListBulkActionResourceTypesBulkActionTypeEnum
func GetListCompartmentsAccessLevelEnumStringValues() []string
GetListCompartmentsAccessLevelEnumStringValues Enumerates the set of values in String for ListCompartmentsAccessLevelEnum
func GetListCompartmentsSortByEnumStringValues() []string
GetListCompartmentsSortByEnumStringValues Enumerates the set of values in String for ListCompartmentsSortByEnum
func GetListCompartmentsSortOrderEnumStringValues() []string
GetListCompartmentsSortOrderEnumStringValues Enumerates the set of values in String for ListCompartmentsSortOrderEnum
func GetListDbCredentialsSortByEnumStringValues() []string
GetListDbCredentialsSortByEnumStringValues Enumerates the set of values in String for ListDbCredentialsSortByEnum
func GetListDbCredentialsSortOrderEnumStringValues() []string
GetListDbCredentialsSortOrderEnumStringValues Enumerates the set of values in String for ListDbCredentialsSortOrderEnum
func GetListDomainsSortByEnumStringValues() []string
GetListDomainsSortByEnumStringValues Enumerates the set of values in String for ListDomainsSortByEnum
func GetListDomainsSortOrderEnumStringValues() []string
GetListDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListDomainsSortOrderEnum
func GetListDynamicGroupsSortByEnumStringValues() []string
GetListDynamicGroupsSortByEnumStringValues Enumerates the set of values in String for ListDynamicGroupsSortByEnum
func GetListDynamicGroupsSortOrderEnumStringValues() []string
GetListDynamicGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListDynamicGroupsSortOrderEnum
func GetListGroupsSortByEnumStringValues() []string
GetListGroupsSortByEnumStringValues Enumerates the set of values in String for ListGroupsSortByEnum
func GetListGroupsSortOrderEnumStringValues() []string
GetListGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListGroupsSortOrderEnum
func GetListIamWorkRequestErrorsSortOrderEnumStringValues() []string
GetListIamWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListIamWorkRequestErrorsSortOrderEnum
func GetListIamWorkRequestLogsSortOrderEnumStringValues() []string
GetListIamWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListIamWorkRequestLogsSortOrderEnum
func GetListIdentityProvidersProtocolEnumStringValues() []string
GetListIdentityProvidersProtocolEnumStringValues Enumerates the set of values in String for ListIdentityProvidersProtocolEnum
func GetListIdentityProvidersSortByEnumStringValues() []string
GetListIdentityProvidersSortByEnumStringValues Enumerates the set of values in String for ListIdentityProvidersSortByEnum
func GetListIdentityProvidersSortOrderEnumStringValues() []string
GetListIdentityProvidersSortOrderEnumStringValues Enumerates the set of values in String for ListIdentityProvidersSortOrderEnum
func GetListMfaTotpDevicesSortByEnumStringValues() []string
GetListMfaTotpDevicesSortByEnumStringValues Enumerates the set of values in String for ListMfaTotpDevicesSortByEnum
func GetListMfaTotpDevicesSortOrderEnumStringValues() []string
GetListMfaTotpDevicesSortOrderEnumStringValues Enumerates the set of values in String for ListMfaTotpDevicesSortOrderEnum
func GetListNetworkSourcesSortByEnumStringValues() []string
GetListNetworkSourcesSortByEnumStringValues Enumerates the set of values in String for ListNetworkSourcesSortByEnum
func GetListNetworkSourcesSortOrderEnumStringValues() []string
GetListNetworkSourcesSortOrderEnumStringValues Enumerates the set of values in String for ListNetworkSourcesSortOrderEnum
func GetListPoliciesSortByEnumStringValues() []string
GetListPoliciesSortByEnumStringValues Enumerates the set of values in String for ListPoliciesSortByEnum
func GetListPoliciesSortOrderEnumStringValues() []string
GetListPoliciesSortOrderEnumStringValues Enumerates the set of values in String for ListPoliciesSortOrderEnum
func GetListUsersSortByEnumStringValues() []string
GetListUsersSortByEnumStringValues Enumerates the set of values in String for ListUsersSortByEnum
func GetListUsersSortOrderEnumStringValues() []string
GetListUsersSortOrderEnumStringValues Enumerates the set of values in String for ListUsersSortOrderEnum
func GetMfaTotpDeviceLifecycleStateEnumStringValues() []string
GetMfaTotpDeviceLifecycleStateEnumStringValues Enumerates the set of values in String for MfaTotpDeviceLifecycleStateEnum
func GetMfaTotpDeviceSummaryLifecycleStateEnumStringValues() []string
GetMfaTotpDeviceSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for MfaTotpDeviceSummaryLifecycleStateEnum
func GetNetworkSourcesLifecycleStateEnumStringValues() []string
GetNetworkSourcesLifecycleStateEnumStringValues Enumerates the set of values in String for NetworkSourcesLifecycleStateEnum
func GetOAuth2ClientCredentialLifecycleStateEnumStringValues() []string
GetOAuth2ClientCredentialLifecycleStateEnumStringValues Enumerates the set of values in String for OAuth2ClientCredentialLifecycleStateEnum
func GetOAuth2ClientCredentialSummaryLifecycleStateEnumStringValues() []string
GetOAuth2ClientCredentialSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for OAuth2ClientCredentialSummaryLifecycleStateEnum
func GetPolicyLifecycleStateEnumStringValues() []string
GetPolicyLifecycleStateEnumStringValues Enumerates the set of values in String for PolicyLifecycleStateEnum
func GetRegionSubscriptionStatusEnumStringValues() []string
GetRegionSubscriptionStatusEnumStringValues Enumerates the set of values in String for RegionSubscriptionStatusEnum
func GetRemoveLockDetailsTypeEnumStringValues() []string
GetRemoveLockDetailsTypeEnumStringValues Enumerates the set of values in String for RemoveLockDetailsTypeEnum
func GetReplicatedRegionDetailsStateEnumStringValues() []string
GetReplicatedRegionDetailsStateEnumStringValues Enumerates the set of values in String for ReplicatedRegionDetailsStateEnum
func GetResourceLockTypeEnumStringValues() []string
GetResourceLockTypeEnumStringValues Enumerates the set of values in String for ResourceLockTypeEnum
func GetSmtpCredentialLifecycleStateEnumStringValues() []string
GetSmtpCredentialLifecycleStateEnumStringValues Enumerates the set of values in String for SmtpCredentialLifecycleStateEnum
func GetSmtpCredentialSummaryLifecycleStateEnumStringValues() []string
GetSmtpCredentialSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for SmtpCredentialSummaryLifecycleStateEnum
func GetStandardTagDefinitionTemplateEnumMutabilityEnumStringValues() []string
GetStandardTagDefinitionTemplateEnumMutabilityEnumStringValues Enumerates the set of values in String for StandardTagDefinitionTemplateEnumMutabilityEnum
func GetStandardTagDefinitionTemplateTypeEnumStringValues() []string
GetStandardTagDefinitionTemplateTypeEnumStringValues Enumerates the set of values in String for StandardTagDefinitionTemplateTypeEnum
func GetSwiftPasswordLifecycleStateEnumStringValues() []string
GetSwiftPasswordLifecycleStateEnumStringValues Enumerates the set of values in String for SwiftPasswordLifecycleStateEnum
func GetTagDefaultLifecycleStateEnumStringValues() []string
GetTagDefaultLifecycleStateEnumStringValues Enumerates the set of values in String for TagDefaultLifecycleStateEnum
func GetTagDefaultSummaryLifecycleStateEnumStringValues() []string
GetTagDefaultSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for TagDefaultSummaryLifecycleStateEnum
func GetTagLifecycleStateEnumStringValues() []string
GetTagLifecycleStateEnumStringValues Enumerates the set of values in String for TagLifecycleStateEnum
func GetTagNamespaceLifecycleStateEnumStringValues() []string
GetTagNamespaceLifecycleStateEnumStringValues Enumerates the set of values in String for TagNamespaceLifecycleStateEnum
func GetTaggingWorkRequestOperationTypeEnumStringValues() []string
GetTaggingWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for TaggingWorkRequestOperationTypeEnum
func GetTaggingWorkRequestStatusEnumStringValues() []string
GetTaggingWorkRequestStatusEnumStringValues Enumerates the set of values in String for TaggingWorkRequestStatusEnum
func GetTaggingWorkRequestSummaryOperationTypeEnumStringValues() []string
GetTaggingWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for TaggingWorkRequestSummaryOperationTypeEnum
func GetTaggingWorkRequestSummaryStatusEnumStringValues() []string
GetTaggingWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for TaggingWorkRequestSummaryStatusEnum
func GetUiPasswordInformationLifecycleStateEnumStringValues() []string
GetUiPasswordInformationLifecycleStateEnumStringValues Enumerates the set of values in String for UiPasswordInformationLifecycleStateEnum
func GetUiPasswordLifecycleStateEnumStringValues() []string
GetUiPasswordLifecycleStateEnumStringValues Enumerates the set of values in String for UiPasswordLifecycleStateEnum
func GetUpdateIdentityProviderDetailsProtocolEnumStringValues() []string
GetUpdateIdentityProviderDetailsProtocolEnumStringValues Enumerates the set of values in String for UpdateIdentityProviderDetailsProtocolEnum
func GetUserGroupMembershipLifecycleStateEnumStringValues() []string
GetUserGroupMembershipLifecycleStateEnumStringValues Enumerates the set of values in String for UserGroupMembershipLifecycleStateEnum
func GetUserLifecycleStateEnumStringValues() []string
GetUserLifecycleStateEnumStringValues Enumerates the set of values in String for UserLifecycleStateEnum
func GetWorkRequestOperationTypeEnumStringValues() []string
GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
func GetWorkRequestSummaryOperationTypeEnumStringValues() []string
GetWorkRequestSummaryOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestSummaryOperationTypeEnum
func GetWorkRequestSummaryStatusEnumStringValues() []string
GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum
ActivateDomainRequest wrapper for the ActivateDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ActivateDomain.go.html to see an example of how to use 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
}
func (request ActivateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateDomainRequest) String() string
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
ActivateDomainResponse wrapper for the ActivateDomain operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ActivateDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateDomainResponse) String() string
ActivateMfaTotpDeviceRequest wrapper for the ActivateMfaTotpDevice operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ActivateMfaTotpDevice.go.html to see an example of how to use 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
}
func (request ActivateMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateMfaTotpDeviceRequest) String() string
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
ActivateMfaTotpDeviceResponse wrapper for the ActivateMfaTotpDevice operation
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"`
}
func (response ActivateMfaTotpDeviceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateMfaTotpDeviceResponse) String() string
AddLockDetails Request payload to add lock to the resource.
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"`
}
func (m AddLockDetails) String() string
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
AddLockDetailsTypeEnum Enum with underlying type: string
type AddLockDetailsTypeEnum string
Set of constants representing the allowable values for AddLockDetailsTypeEnum
const (
AddLockDetailsTypeFull AddLockDetailsTypeEnum = "FULL"
AddLockDetailsTypeDelete AddLockDetailsTypeEnum = "DELETE"
)
func GetAddLockDetailsTypeEnumValues() []AddLockDetailsTypeEnum
GetAddLockDetailsTypeEnumValues Enumerates the set of values for AddLockDetailsTypeEnum
func GetMappingAddLockDetailsTypeEnum(val string) (AddLockDetailsTypeEnum, bool)
GetMappingAddLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddTagDefaultLockRequest wrapper for the AddTagDefaultLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddTagDefaultLock.go.html to see an example of how to use AddTagDefaultLockRequest.
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
}
func (request AddTagDefaultLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddTagDefaultLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddTagDefaultLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddTagDefaultLockRequest) String() string
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
AddTagDefaultLockResponse wrapper for the AddTagDefaultLock operation
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"`
}
func (response AddTagDefaultLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddTagDefaultLockResponse) String() string
AddTagNamespaceLockRequest wrapper for the AddTagNamespaceLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddTagNamespaceLock.go.html to see an example of how to use AddTagNamespaceLockRequest.
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
}
func (request AddTagNamespaceLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddTagNamespaceLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddTagNamespaceLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddTagNamespaceLockRequest) String() string
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
AddTagNamespaceLockResponse wrapper for the AddTagNamespaceLock operation
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"`
}
func (response AddTagNamespaceLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddTagNamespaceLockResponse) String() string
AddUserToGroupDetails The representation of 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"`
}
func (m AddUserToGroupDetails) String() string
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
AddUserToGroupRequest wrapper for the AddUserToGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AddUserToGroup.go.html to see an example of how to use 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
}
func (request AddUserToGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddUserToGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddUserToGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddUserToGroupRequest) String() string
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
AddUserToGroupResponse wrapper for the AddUserToGroup operation
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"`
}
func (response AddUserToGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddUserToGroupResponse) String() string
AllowedDomainLicenseTypeSummary (For tenancies that support identity domains) The 'AllowedDomainLicenseTypeSummary' object contains information about the license type of the identity domain.
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"`
}
func (m AllowedDomainLicenseTypeSummary) String() string
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
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.oracle.com/iaas/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.oracle.com/iaas/Content/Identity/Concepts/usercredentials.htm).
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"`
}
func (m ApiKey) String() string
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
ApiKeyLifecycleStateEnum Enum with underlying type: string
type ApiKeyLifecycleStateEnum string
Set of constants representing the allowable values for ApiKeyLifecycleStateEnum
const (
ApiKeyLifecycleStateCreating ApiKeyLifecycleStateEnum = "CREATING"
ApiKeyLifecycleStateActive ApiKeyLifecycleStateEnum = "ACTIVE"
ApiKeyLifecycleStateInactive ApiKeyLifecycleStateEnum = "INACTIVE"
ApiKeyLifecycleStateDeleting ApiKeyLifecycleStateEnum = "DELETING"
ApiKeyLifecycleStateDeleted ApiKeyLifecycleStateEnum = "DELETED"
)
func GetApiKeyLifecycleStateEnumValues() []ApiKeyLifecycleStateEnum
GetApiKeyLifecycleStateEnumValues Enumerates the set of values for ApiKeyLifecycleStateEnum
func GetMappingApiKeyLifecycleStateEnum(val string) (ApiKeyLifecycleStateEnum, bool)
GetMappingApiKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AssembleEffectiveTagSetRequest wrapper for the AssembleEffectiveTagSet operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/AssembleEffectiveTagSet.go.html to see an example of how to use 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
}
func (request AssembleEffectiveTagSetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AssembleEffectiveTagSetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AssembleEffectiveTagSetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AssembleEffectiveTagSetRequest) String() string
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
AssembleEffectiveTagSetResponse wrapper for the AssembleEffectiveTagSet operation
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"`
}
func (response AssembleEffectiveTagSetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AssembleEffectiveTagSetResponse) String() string
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.oracle.com/iaas/Content/Identity/access/managing-user-credentials.htm).
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"`
}
func (m AuthToken) String() string
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
AuthTokenLifecycleStateEnum Enum with underlying type: string
type AuthTokenLifecycleStateEnum string
Set of constants representing the allowable values for AuthTokenLifecycleStateEnum
const (
AuthTokenLifecycleStateCreating AuthTokenLifecycleStateEnum = "CREATING"
AuthTokenLifecycleStateActive AuthTokenLifecycleStateEnum = "ACTIVE"
AuthTokenLifecycleStateInactive AuthTokenLifecycleStateEnum = "INACTIVE"
AuthTokenLifecycleStateDeleting AuthTokenLifecycleStateEnum = "DELETING"
AuthTokenLifecycleStateDeleted AuthTokenLifecycleStateEnum = "DELETED"
)
func GetAuthTokenLifecycleStateEnumValues() []AuthTokenLifecycleStateEnum
GetAuthTokenLifecycleStateEnumValues Enumerates the set of values for AuthTokenLifecycleStateEnum
func GetMappingAuthTokenLifecycleStateEnum(val string) (AuthTokenLifecycleStateEnum, bool)
GetMappingAuthTokenLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AuthenticationPolicy Authentication policy, currently set for the given compartment.
type AuthenticationPolicy struct {
PasswordPolicy *PasswordPolicy `mandatory:"false" json:"passwordPolicy"`
// Compartment OCID.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
NetworkPolicy *NetworkPolicy `mandatory:"false" json:"networkPolicy"`
}
func (m AuthenticationPolicy) String() string
func (m AuthenticationPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.oracle.com/iaas/Content/General/Concepts/regions.htm).
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"`
}
func (m AvailabilityDomain) String() string
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
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.oracle.com/iaas/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.oracle.com/iaas/api/#/en/identity/latest/datatypes/DefaultTagDefinitionValidator).
type BaseTagDefinitionValidator interface {
}
BaseTagDefinitionValidatorValidatorTypeEnum Enum with underlying type: string
type BaseTagDefinitionValidatorValidatorTypeEnum string
Set of constants representing the allowable values for BaseTagDefinitionValidatorValidatorTypeEnum
const (
BaseTagDefinitionValidatorValidatorTypeEnumvalue BaseTagDefinitionValidatorValidatorTypeEnum = "ENUM"
BaseTagDefinitionValidatorValidatorTypeDefault BaseTagDefinitionValidatorValidatorTypeEnum = "DEFAULT"
)
func GetBaseTagDefinitionValidatorValidatorTypeEnumValues() []BaseTagDefinitionValidatorValidatorTypeEnum
GetBaseTagDefinitionValidatorValidatorTypeEnumValues Enumerates the set of values for BaseTagDefinitionValidatorValidatorTypeEnum
func GetMappingBaseTagDefinitionValidatorValidatorTypeEnum(val string) (BaseTagDefinitionValidatorValidatorTypeEnum, bool)
GetMappingBaseTagDefinitionValidatorValidatorTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BulkActionResource The bulk action resource entity.
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"`
}
func (m BulkActionResource) String() string
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
BulkActionResourceType The representation of 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"`
}
func (m BulkActionResourceType) String() string
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
BulkActionResourceTypeCollection Collection of resource-types supported by a compartment bulk action.
type BulkActionResourceTypeCollection struct {
// Collection of the resource-types supported by a compartment bulk action.
Items []BulkActionResourceType `mandatory:"true" json:"items"`
}
func (m BulkActionResourceTypeCollection) String() string
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
BulkDeleteResourcesDetails The representation of BulkDeleteResourcesDetails
type BulkDeleteResourcesDetails struct {
// The resources to be deleted.
Resources []BulkActionResource `mandatory:"true" json:"resources"`
}
func (m BulkDeleteResourcesDetails) String() string
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
BulkDeleteResourcesRequest wrapper for the BulkDeleteResources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkDeleteResources.go.html to see an example of how to use 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
}
func (request BulkDeleteResourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BulkDeleteResourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BulkDeleteResourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BulkDeleteResourcesRequest) String() string
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
BulkDeleteResourcesResponse wrapper for the BulkDeleteResources operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BulkDeleteResourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BulkDeleteResourcesResponse) String() string
BulkDeleteTagsDetails Properties for deleting tags in bulk
type BulkDeleteTagsDetails struct {
// The OCIDs of the tag definitions to delete
TagDefinitionIds []string `mandatory:"true" json:"tagDefinitionIds"`
}
func (m BulkDeleteTagsDetails) String() string
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
BulkDeleteTagsRequest wrapper for the BulkDeleteTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkDeleteTags.go.html to see an example of how to use 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
}
func (request BulkDeleteTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BulkDeleteTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BulkDeleteTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BulkDeleteTagsRequest) String() string
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
BulkDeleteTagsResponse wrapper for the BulkDeleteTags operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BulkDeleteTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BulkDeleteTagsResponse) String() string
BulkEditOperationDetails The representation of 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
}
func (m BulkEditOperationDetails) String() string
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
BulkEditOperationDetailsOperationTypeEnum Enum with underlying type: string
type BulkEditOperationDetailsOperationTypeEnum string
Set of constants representing the allowable values for BulkEditOperationDetailsOperationTypeEnum
const (
BulkEditOperationDetailsOperationTypeAddWhereAbsent BulkEditOperationDetailsOperationTypeEnum = "ADD_WHERE_ABSENT"
BulkEditOperationDetailsOperationTypeSetWherePresent BulkEditOperationDetailsOperationTypeEnum = "SET_WHERE_PRESENT"
BulkEditOperationDetailsOperationTypeAddOrSet BulkEditOperationDetailsOperationTypeEnum = "ADD_OR_SET"
BulkEditOperationDetailsOperationTypeRemove BulkEditOperationDetailsOperationTypeEnum = "REMOVE"
)
func GetBulkEditOperationDetailsOperationTypeEnumValues() []BulkEditOperationDetailsOperationTypeEnum
GetBulkEditOperationDetailsOperationTypeEnumValues Enumerates the set of values for BulkEditOperationDetailsOperationTypeEnum
func GetMappingBulkEditOperationDetailsOperationTypeEnum(val string) (BulkEditOperationDetailsOperationTypeEnum, bool)
GetMappingBulkEditOperationDetailsOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BulkEditResource The representation of 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"`
}
func (m BulkEditResource) String() string
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
BulkEditTagsDetails The representation of 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"`
}
func (m BulkEditTagsDetails) String() string
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
BulkEditTagsRequest wrapper for the BulkEditTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkEditTags.go.html to see an example of how to use 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
}
func (request BulkEditTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BulkEditTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BulkEditTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BulkEditTagsRequest) String() string
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
BulkEditTagsResourceType The representation of 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.oracle.com/iaas/api/#/en/objectstorage/latest/Bucket/UpdateBucket) and
// DeleteBucket (https://docs.oracle.com/iaas/api/#/en/objectstorage/latest/Bucket/DeleteBucket).
MetadataKeys []string `mandatory:"false" json:"metadataKeys"`
}
func (m BulkEditTagsResourceType) String() string
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
BulkEditTagsResourceTypeCollection The list of resource types that support bulk editing of tags.
type BulkEditTagsResourceTypeCollection struct {
// The collection of resource types that support bulk editing of tags.
Items []BulkEditTagsResourceType `mandatory:"true" json:"items"`
}
func (m BulkEditTagsResourceTypeCollection) String() string
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
BulkEditTagsResponse wrapper for the BulkEditTags operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BulkEditTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BulkEditTagsResponse) String() string
BulkMoveResourcesDetails The representation of BulkMoveResourcesDetails
type BulkMoveResourcesDetails struct {
// The resources to be moved.
Resources []BulkActionResource `mandatory:"true" json:"resources"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment
// into which to move the resources.
TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`
}
func (m BulkMoveResourcesDetails) String() string
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
BulkMoveResourcesRequest wrapper for the BulkMoveResources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/BulkMoveResources.go.html to see an example of how to use 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
}
func (request BulkMoveResourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BulkMoveResourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BulkMoveResourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BulkMoveResourcesRequest) String() string
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
BulkMoveResourcesResponse wrapper for the BulkMoveResources operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BulkMoveResourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BulkMoveResourcesResponse) String() string
CascadeDeleteTagNamespaceRequest wrapper for the CascadeDeleteTagNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CascadeDeleteTagNamespace.go.html to see an example of how to use 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
}
func (request CascadeDeleteTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CascadeDeleteTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CascadeDeleteTagNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CascadeDeleteTagNamespaceRequest) String() string
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
CascadeDeleteTagNamespaceResponse wrapper for the CascadeDeleteTagNamespace operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CascadeDeleteTagNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CascadeDeleteTagNamespaceResponse) String() string
ChangeDomainCompartmentDetails The representation of ChangeDomainCompartmentDetails
type ChangeDomainCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment
// into which to move the identity domain.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDomainCompartmentDetails) String() string
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
ChangeDomainCompartmentRequest wrapper for the ChangeDomainCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeDomainCompartment.go.html to see an example of how to use 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
}
func (request ChangeDomainCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDomainCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDomainCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDomainCompartmentRequest) String() string
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
ChangeDomainCompartmentResponse wrapper for the ChangeDomainCompartment operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeDomainCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDomainCompartmentResponse) String() string
ChangeDomainLicenseTypeDetails (For tenancies that support identity domains) Details for updating the license type of the identity domain.
type ChangeDomainLicenseTypeDetails struct {
// The license type of the identity domain.
LicenseType *string `mandatory:"false" json:"licenseType"`
}
func (m ChangeDomainLicenseTypeDetails) String() string
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
ChangeDomainLicenseTypeRequest wrapper for the ChangeDomainLicenseType operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeDomainLicenseType.go.html to see an example of how to use 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
}
func (request ChangeDomainLicenseTypeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDomainLicenseTypeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDomainLicenseTypeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDomainLicenseTypeRequest) String() string
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
ChangeDomainLicenseTypeResponse wrapper for the ChangeDomainLicenseType operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeDomainLicenseTypeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDomainLicenseTypeResponse) String() string
ChangeTagNamespaceCompartmentDetail Details of the compartment the resource is being moved to.
type ChangeTagNamespaceCompartmentDetail struct {
// The Oracle Cloud ID (OCID) of the destination compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeTagNamespaceCompartmentDetail) String() string
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
ChangeTagNamespaceCompartmentRequest wrapper for the ChangeTagNamespaceCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ChangeTagNamespaceCompartment.go.html to see an example of how to use 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
}
func (request ChangeTagNamespaceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeTagNamespaceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeTagNamespaceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeTagNamespaceCompartmentRequest) String() string
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
ChangeTagNamespaceCompartmentResponse wrapper for the ChangeTagNamespaceCompartment operation
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"`
}
func (response ChangeTagNamespaceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeTagNamespaceCompartmentResponse) String() string
ChangeTasDomainLicenseTypeDetails (For tenancies that support identity domains) Update the identity domain license type.
type ChangeTasDomainLicenseTypeDetails struct {
// The license type of the identity domain.
LicenseType *string `mandatory:"false" json:"licenseType"`
}
func (m ChangeTasDomainLicenseTypeDetails) String() string
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
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.oracle.com/iaas//Content/Identity/getstarted/identity-domains.htm) and also Setting Up Your Tenancy (https://docs.oracle.com/iaas/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.oracle.com/iaas/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 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Compartment) String() string
func (m Compartment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CompartmentLifecycleStateEnum Enum with underlying type: string
type CompartmentLifecycleStateEnum string
Set of constants representing the allowable values for CompartmentLifecycleStateEnum
const (
CompartmentLifecycleStateCreating CompartmentLifecycleStateEnum = "CREATING"
CompartmentLifecycleStateActive CompartmentLifecycleStateEnum = "ACTIVE"
CompartmentLifecycleStateInactive CompartmentLifecycleStateEnum = "INACTIVE"
CompartmentLifecycleStateDeleting CompartmentLifecycleStateEnum = "DELETING"
CompartmentLifecycleStateDeleted CompartmentLifecycleStateEnum = "DELETED"
)
func GetCompartmentLifecycleStateEnumValues() []CompartmentLifecycleStateEnum
GetCompartmentLifecycleStateEnumValues Enumerates the set of values for CompartmentLifecycleStateEnum
func GetMappingCompartmentLifecycleStateEnum(val string) (CompartmentLifecycleStateEnum, bool)
GetMappingCompartmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CreateApiKeyDetails The representation of CreateApiKeyDetails
type CreateApiKeyDetails struct {
// The public key. Must be an RSA key in PEM format.
Key *string `mandatory:"true" json:"key"`
}
func (m CreateApiKeyDetails) String() string
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
CreateAuthTokenDetails The representation of 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"`
}
func (m CreateAuthTokenDetails) String() string
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
CreateAuthTokenRequest wrapper for the CreateAuthToken operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateAuthToken.go.html to see an example of how to use 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
}
func (request CreateAuthTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAuthTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAuthTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAuthTokenRequest) String() string
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
CreateAuthTokenResponse wrapper for the CreateAuthToken operation
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"`
}
func (response CreateAuthTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAuthTokenResponse) String() string
CreateCompartmentDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateCompartmentDetails) String() string
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
CreateCompartmentRequest wrapper for the CreateCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateCompartment.go.html to see an example of how to use 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
}
func (request CreateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCompartmentRequest) String() string
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
CreateCompartmentResponse wrapper for the CreateCompartment operation
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"`
}
func (response CreateCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCompartmentResponse) String() string
CreateCustomerSecretKeyDetails The representation of 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"`
}
func (m CreateCustomerSecretKeyDetails) String() string
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
CreateCustomerSecretKeyRequest wrapper for the CreateCustomerSecretKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateCustomerSecretKey.go.html to see an example of how to use 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
}
func (request CreateCustomerSecretKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCustomerSecretKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCustomerSecretKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCustomerSecretKeyRequest) String() string
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
CreateCustomerSecretKeyResponse wrapper for the CreateCustomerSecretKey operation
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"`
}
func (response CreateCustomerSecretKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCustomerSecretKeyResponse) String() string
CreateDbCredentialDetails The representation of 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"`
}
func (m CreateDbCredentialDetails) String() string
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
CreateDbCredentialRequest wrapper for the CreateDbCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDbCredential.go.html to see an example of how to use 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
}
func (request CreateDbCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDbCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDbCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDbCredentialRequest) String() string
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
CreateDbCredentialResponse wrapper for the CreateDbCredential operation
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"`
}
func (response CreateDbCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDbCredentialResponse) String() string
CreateDomainDetails (For tenancies that support identity domains) Details for creating an identity domain.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDomainDetails) String() string
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
CreateDomainRequest wrapper for the CreateDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDomain.go.html to see an example of how to use 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
}
func (request CreateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDomainRequest) String() string
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
CreateDomainResponse wrapper for the CreateDomain operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDomainResponse) String() string
CreateDynamicGroupDetails Properties for creating a dynamic group.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDynamicGroupDetails) String() string
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
CreateDynamicGroupRequest wrapper for the CreateDynamicGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateDynamicGroup.go.html to see an example of how to use 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
}
func (request CreateDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDynamicGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDynamicGroupRequest) String() string
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
CreateDynamicGroupResponse wrapper for the CreateDynamicGroup operation
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"`
}
func (response CreateDynamicGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDynamicGroupResponse) String() string
CreateGroupDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateGroupDetails) String() string
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
CreateGroupRequest wrapper for the CreateGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateGroup.go.html to see an example of how to use 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
}
func (request CreateGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGroupRequest) String() string
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
CreateGroupResponse wrapper for the CreateGroup operation
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"`
}
func (response CreateGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGroupResponse) String() string
CreateIdentityProviderDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateIdentityProviderDetailsProductTypeEnum Enum with underlying type: string
type CreateIdentityProviderDetailsProductTypeEnum string
Set of constants representing the allowable values for CreateIdentityProviderDetailsProductTypeEnum
const (
CreateIdentityProviderDetailsProductTypeIdcs CreateIdentityProviderDetailsProductTypeEnum = "IDCS"
CreateIdentityProviderDetailsProductTypeAdfs CreateIdentityProviderDetailsProductTypeEnum = "ADFS"
)
func GetCreateIdentityProviderDetailsProductTypeEnumValues() []CreateIdentityProviderDetailsProductTypeEnum
GetCreateIdentityProviderDetailsProductTypeEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProductTypeEnum
func GetMappingCreateIdentityProviderDetailsProductTypeEnum(val string) (CreateIdentityProviderDetailsProductTypeEnum, bool)
GetMappingCreateIdentityProviderDetailsProductTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIdentityProviderDetailsProtocolEnum Enum with underlying type: string
type CreateIdentityProviderDetailsProtocolEnum string
Set of constants representing the allowable values for CreateIdentityProviderDetailsProtocolEnum
const (
CreateIdentityProviderDetailsProtocolSaml2 CreateIdentityProviderDetailsProtocolEnum = "SAML2"
CreateIdentityProviderDetailsProtocolAdfs CreateIdentityProviderDetailsProtocolEnum = "ADFS"
)
func GetCreateIdentityProviderDetailsProtocolEnumValues() []CreateIdentityProviderDetailsProtocolEnum
GetCreateIdentityProviderDetailsProtocolEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProtocolEnum
func GetMappingCreateIdentityProviderDetailsProtocolEnum(val string) (CreateIdentityProviderDetailsProtocolEnum, bool)
GetMappingCreateIdentityProviderDetailsProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIdentityProviderRequest wrapper for the CreateIdentityProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateIdentityProvider.go.html to see an example of how to use 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
}
func (request CreateIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateIdentityProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateIdentityProviderRequest) String() string
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
CreateIdentityProviderResponse wrapper for the CreateIdentityProvider operation
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"`
}
func (response CreateIdentityProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateIdentityProviderResponse) String() string
CreateIdpGroupMappingDetails The representation of 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"`
}
func (m CreateIdpGroupMappingDetails) String() string
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
CreateIdpGroupMappingRequest wrapper for the CreateIdpGroupMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateIdpGroupMapping.go.html to see an example of how to use 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
}
func (request CreateIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateIdpGroupMappingRequest) String() string
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
CreateIdpGroupMappingResponse wrapper for the CreateIdpGroupMapping operation
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"`
}
func (response CreateIdpGroupMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateIdpGroupMappingResponse) String() string
CreateMfaTotpDeviceRequest wrapper for the CreateMfaTotpDevice operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateMfaTotpDevice.go.html to see an example of how to use 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
}
func (request CreateMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateMfaTotpDeviceRequest) String() string
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
CreateMfaTotpDeviceResponse wrapper for the CreateMfaTotpDevice operation
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"`
}
func (response CreateMfaTotpDeviceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateMfaTotpDeviceResponse) String() string
CreateNetworkSourceDetails Properties for creating a network source object.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateNetworkSourceDetails) String() string
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
CreateNetworkSourceRequest wrapper for the CreateNetworkSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateNetworkSource.go.html to see an example of how to use 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
}
func (request CreateNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateNetworkSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateNetworkSourceRequest) String() string
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
CreateNetworkSourceResponse wrapper for the CreateNetworkSource operation
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"`
}
func (response CreateNetworkSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateNetworkSourceResponse) String() string
CreateOAuth2ClientCredentialDetails The representation of 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"`
}
func (m CreateOAuth2ClientCredentialDetails) String() string
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
CreateOAuthClientCredentialRequest wrapper for the CreateOAuthClientCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateOAuthClientCredential.go.html to see an example of how to use 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
}
func (request CreateOAuthClientCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOAuthClientCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOAuthClientCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOAuthClientCredentialRequest) String() string
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
CreateOAuthClientCredentialResponse wrapper for the CreateOAuthClientCredential operation
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"`
}
func (response CreateOAuthClientCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOAuthClientCredentialResponse) String() string
CreateOrResetUIPasswordRequest wrapper for the CreateOrResetUIPassword operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateOrResetUIPassword.go.html to see an example of how to use 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
}
func (request CreateOrResetUIPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOrResetUIPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOrResetUIPasswordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOrResetUIPasswordRequest) String() string
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
CreateOrResetUIPasswordResponse wrapper for the CreateOrResetUIPassword operation
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"`
}
func (response CreateOrResetUIPasswordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOrResetUIPasswordResponse) String() string
CreatePolicyDetails The representation of 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.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm) and
// Common Policies (https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreatePolicyDetails) String() string
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
CreatePolicyRequest wrapper for the CreatePolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreatePolicy.go.html to see an example of how to use 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
}
func (request CreatePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePolicyRequest) String() string
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
CreatePolicyResponse wrapper for the CreatePolicy operation
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"`
}
func (response CreatePolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePolicyResponse) String() string
CreateRegionSubscriptionDetails The representation of CreateRegionSubscriptionDetails
type CreateRegionSubscriptionDetails struct {
// The regions's key. See Regions and Availability Domains (https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm) for
// the full list of supported 3-letter region codes.
// Example: `PHX`
RegionKey *string `mandatory:"true" json:"regionKey"`
}
func (m CreateRegionSubscriptionDetails) String() string
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
CreateRegionSubscriptionRequest wrapper for the CreateRegionSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateRegionSubscription.go.html to see an example of how to use 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
}
func (request CreateRegionSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRegionSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRegionSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRegionSubscriptionRequest) String() string
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
CreateRegionSubscriptionResponse wrapper for the CreateRegionSubscription operation
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"`
}
func (response CreateRegionSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRegionSubscriptionResponse) String() string
CreateSaml2IdentityProviderDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m CreateSaml2IdentityProviderDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateSaml2IdentityProviderDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateSaml2IdentityProviderDetails) GetDescription() *string
GetDescription returns Description
func (m CreateSaml2IdentityProviderDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateSaml2IdentityProviderDetails) GetName() *string
GetName returns Name
func (m CreateSaml2IdentityProviderDetails) GetProductType() CreateIdentityProviderDetailsProductTypeEnum
GetProductType returns ProductType
func (m CreateSaml2IdentityProviderDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSaml2IdentityProviderDetails) String() string
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
CreateSmtpCredentialDetails The representation of 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"`
}
func (m CreateSmtpCredentialDetails) String() string
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
CreateSmtpCredentialRequest wrapper for the CreateSmtpCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateSmtpCredential.go.html to see an example of how to use 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
}
func (request CreateSmtpCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSmtpCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSmtpCredentialRequest) String() string
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
CreateSmtpCredentialResponse wrapper for the CreateSmtpCredential operation
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"`
}
func (response CreateSmtpCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSmtpCredentialResponse) String() string
CreateSwiftPasswordDetails The representation of 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"`
}
func (m CreateSwiftPasswordDetails) String() string
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
CreateSwiftPasswordRequest wrapper for the CreateSwiftPassword operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateSwiftPassword.go.html to see an example of how to use 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
}
func (request CreateSwiftPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSwiftPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSwiftPasswordRequest) String() string
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
CreateSwiftPasswordResponse wrapper for the CreateSwiftPassword operation
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"`
}
func (response CreateSwiftPasswordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSwiftPasswordResponse) String() string
CreateTagDefaultDetails The representation of 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"`
}
func (m CreateTagDefaultDetails) String() string
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
CreateTagDefaultRequest wrapper for the CreateTagDefault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTagDefault.go.html to see an example of how to use 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
}
func (request CreateTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTagDefaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTagDefaultRequest) String() string
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
CreateTagDefaultResponse wrapper for the CreateTagDefault operation
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"`
}
func (response CreateTagDefaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTagDefaultResponse) String() string
CreateTagDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m CreateTagDetails) String() string
func (m *CreateTagDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateTagNamespaceDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m CreateTagNamespaceDetails) String() string
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
CreateTagNamespaceRequest wrapper for the CreateTagNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTagNamespace.go.html to see an example of how to use 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
}
func (request CreateTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTagNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTagNamespaceRequest) String() string
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
CreateTagNamespaceResponse wrapper for the CreateTagNamespace operation
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"`
}
func (response CreateTagNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTagNamespaceResponse) String() string
CreateTagRequest wrapper for the CreateTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateTag.go.html to see an example of how to use 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
}
func (request CreateTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTagRequest) String() string
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
CreateTagResponse wrapper for the CreateTag operation
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"`
}
func (response CreateTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTagResponse) String() string
CreateUserDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateUserDetails) String() string
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
CreateUserRequest wrapper for the CreateUser operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/CreateUser.go.html to see an example of how to use 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
}
func (request CreateUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateUserRequest) String() string
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
CreateUserResponse wrapper for the CreateUser operation
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"`
}
func (response CreateUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateUserResponse) String() string
CustomerSecretKey A `CustomerSecretKey` is an Oracle-provided key for using the Object Storage Service's Amazon S3 compatible API (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/Identity/access/managing-user-credentials.htm).
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"`
}
func (m CustomerSecretKey) String() string
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
CustomerSecretKeyLifecycleStateEnum Enum with underlying type: string
type CustomerSecretKeyLifecycleStateEnum string
Set of constants representing the allowable values for CustomerSecretKeyLifecycleStateEnum
const (
CustomerSecretKeyLifecycleStateCreating CustomerSecretKeyLifecycleStateEnum = "CREATING"
CustomerSecretKeyLifecycleStateActive CustomerSecretKeyLifecycleStateEnum = "ACTIVE"
CustomerSecretKeyLifecycleStateInactive CustomerSecretKeyLifecycleStateEnum = "INACTIVE"
CustomerSecretKeyLifecycleStateDeleting CustomerSecretKeyLifecycleStateEnum = "DELETING"
CustomerSecretKeyLifecycleStateDeleted CustomerSecretKeyLifecycleStateEnum = "DELETED"
)
func GetCustomerSecretKeyLifecycleStateEnumValues() []CustomerSecretKeyLifecycleStateEnum
GetCustomerSecretKeyLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeyLifecycleStateEnum
func GetMappingCustomerSecretKeyLifecycleStateEnum(val string) (CustomerSecretKeyLifecycleStateEnum, bool)
GetMappingCustomerSecretKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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.
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"`
}
func (m CustomerSecretKeySummary) String() string
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
CustomerSecretKeySummaryLifecycleStateEnum Enum with underlying type: string
type CustomerSecretKeySummaryLifecycleStateEnum string
Set of constants representing the allowable values for CustomerSecretKeySummaryLifecycleStateEnum
const (
CustomerSecretKeySummaryLifecycleStateCreating CustomerSecretKeySummaryLifecycleStateEnum = "CREATING"
CustomerSecretKeySummaryLifecycleStateActive CustomerSecretKeySummaryLifecycleStateEnum = "ACTIVE"
CustomerSecretKeySummaryLifecycleStateInactive CustomerSecretKeySummaryLifecycleStateEnum = "INACTIVE"
CustomerSecretKeySummaryLifecycleStateDeleting CustomerSecretKeySummaryLifecycleStateEnum = "DELETING"
CustomerSecretKeySummaryLifecycleStateDeleted CustomerSecretKeySummaryLifecycleStateEnum = "DELETED"
)
func GetCustomerSecretKeySummaryLifecycleStateEnumValues() []CustomerSecretKeySummaryLifecycleStateEnum
GetCustomerSecretKeySummaryLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeySummaryLifecycleStateEnum
func GetMappingCustomerSecretKeySummaryLifecycleStateEnum(val string) (CustomerSecretKeySummaryLifecycleStateEnum, bool)
GetMappingCustomerSecretKeySummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DbCredential Database credentials are needed for onboarding cloud database to identity. The DB credentials are used for DB authentication with the service.
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"`
}
func (m DbCredential) String() string
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
DbCredentialLifecycleStateEnum Enum with underlying type: string
type DbCredentialLifecycleStateEnum string
Set of constants representing the allowable values for DbCredentialLifecycleStateEnum
const (
DbCredentialLifecycleStateCreating DbCredentialLifecycleStateEnum = "CREATING"
DbCredentialLifecycleStateActive DbCredentialLifecycleStateEnum = "ACTIVE"
DbCredentialLifecycleStateDeleting DbCredentialLifecycleStateEnum = "DELETING"
DbCredentialLifecycleStateDeleted DbCredentialLifecycleStateEnum = "DELETED"
)
func GetDbCredentialLifecycleStateEnumValues() []DbCredentialLifecycleStateEnum
GetDbCredentialLifecycleStateEnumValues Enumerates the set of values for DbCredentialLifecycleStateEnum
func GetMappingDbCredentialLifecycleStateEnum(val string) (DbCredentialLifecycleStateEnum, bool)
GetMappingDbCredentialLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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].
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"`
}
func (m DbCredentialSummary) String() string
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
DeactivateDomainRequest wrapper for the DeactivateDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeactivateDomain.go.html to see an example of how to use 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
}
func (request DeactivateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeactivateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeactivateDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeactivateDomainRequest) String() string
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
DeactivateDomainResponse wrapper for the DeactivateDomain operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeactivateDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeactivateDomainResponse) String() string
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`.
type DefaultTagDefinitionValidator struct {
}
func (m DefaultTagDefinitionValidator) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefaultTagDefinitionValidator) String() string
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
DeleteApiKeyRequest wrapper for the DeleteApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteApiKey.go.html to see an example of how to use 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
}
func (request DeleteApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApiKeyRequest) String() string
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
DeleteApiKeyResponse wrapper for the DeleteApiKey operation
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"`
}
func (response DeleteApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApiKeyResponse) String() string
DeleteAuthTokenRequest wrapper for the DeleteAuthToken operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteAuthToken.go.html to see an example of how to use 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
}
func (request DeleteAuthTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAuthTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAuthTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAuthTokenRequest) String() string
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
DeleteAuthTokenResponse wrapper for the DeleteAuthToken operation
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"`
}
func (response DeleteAuthTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAuthTokenResponse) String() string
DeleteCompartmentRequest wrapper for the DeleteCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteCompartment.go.html to see an example of how to use 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
}
func (request DeleteCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCompartmentRequest) String() string
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
DeleteCompartmentResponse wrapper for the DeleteCompartment operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCompartmentResponse) String() string
DeleteCustomerSecretKeyRequest wrapper for the DeleteCustomerSecretKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteCustomerSecretKey.go.html to see an example of how to use 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
}
func (request DeleteCustomerSecretKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCustomerSecretKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCustomerSecretKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCustomerSecretKeyRequest) String() string
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
DeleteCustomerSecretKeyResponse wrapper for the DeleteCustomerSecretKey operation
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"`
}
func (response DeleteCustomerSecretKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCustomerSecretKeyResponse) String() string
DeleteDbCredentialRequest wrapper for the DeleteDbCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDbCredential.go.html to see an example of how to use 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
}
func (request DeleteDbCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDbCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDbCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDbCredentialRequest) String() string
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
DeleteDbCredentialResponse wrapper for the DeleteDbCredential operation
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"`
}
func (response DeleteDbCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDbCredentialResponse) String() string
DeleteDomainRequest wrapper for the DeleteDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDomain.go.html to see an example of how to use 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
}
func (request DeleteDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDomainRequest) String() string
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
DeleteDomainResponse wrapper for the DeleteDomain operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDomainResponse) String() string
DeleteDynamicGroupRequest wrapper for the DeleteDynamicGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteDynamicGroup.go.html to see an example of how to use 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
}
func (request DeleteDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDynamicGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDynamicGroupRequest) String() string
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
DeleteDynamicGroupResponse wrapper for the DeleteDynamicGroup operation
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"`
}
func (response DeleteDynamicGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDynamicGroupResponse) String() string
DeleteGroupRequest wrapper for the DeleteGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteGroup.go.html to see an example of how to use 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
}
func (request DeleteGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteGroupRequest) String() string
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
DeleteGroupResponse wrapper for the DeleteGroup operation
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"`
}
func (response DeleteGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteGroupResponse) String() string
DeleteIdentityProviderRequest wrapper for the DeleteIdentityProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteIdentityProvider.go.html to see an example of how to use 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
}
func (request DeleteIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteIdentityProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteIdentityProviderRequest) String() string
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
DeleteIdentityProviderResponse wrapper for the DeleteIdentityProvider operation
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"`
}
func (response DeleteIdentityProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteIdentityProviderResponse) String() string
DeleteIdpGroupMappingRequest wrapper for the DeleteIdpGroupMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteIdpGroupMapping.go.html to see an example of how to use 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
}
func (request DeleteIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteIdpGroupMappingRequest) String() string
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
DeleteIdpGroupMappingResponse wrapper for the DeleteIdpGroupMapping operation
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"`
}
func (response DeleteIdpGroupMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteIdpGroupMappingResponse) String() string
DeleteMfaTotpDeviceRequest wrapper for the DeleteMfaTotpDevice operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteMfaTotpDevice.go.html to see an example of how to use 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
}
func (request DeleteMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteMfaTotpDeviceRequest) String() string
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
DeleteMfaTotpDeviceResponse wrapper for the DeleteMfaTotpDevice operation
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"`
}
func (response DeleteMfaTotpDeviceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteMfaTotpDeviceResponse) String() string
DeleteNetworkSourceRequest wrapper for the DeleteNetworkSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteNetworkSource.go.html to see an example of how to use 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
}
func (request DeleteNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteNetworkSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteNetworkSourceRequest) String() string
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
DeleteNetworkSourceResponse wrapper for the DeleteNetworkSource operation
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"`
}
func (response DeleteNetworkSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteNetworkSourceResponse) String() string
DeleteOAuthClientCredentialRequest wrapper for the DeleteOAuthClientCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteOAuthClientCredential.go.html to see an example of how to use 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
}
func (request DeleteOAuthClientCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOAuthClientCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOAuthClientCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOAuthClientCredentialRequest) String() string
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
DeleteOAuthClientCredentialResponse wrapper for the DeleteOAuthClientCredential operation
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"`
}
func (response DeleteOAuthClientCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOAuthClientCredentialResponse) String() string
DeletePolicyRequest wrapper for the DeletePolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeletePolicy.go.html to see an example of how to use 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
}
func (request DeletePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePolicyRequest) String() string
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
DeletePolicyResponse wrapper for the DeletePolicy operation
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"`
}
func (response DeletePolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePolicyResponse) String() string
DeleteSmtpCredentialRequest wrapper for the DeleteSmtpCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteSmtpCredential.go.html to see an example of how to use 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
}
func (request DeleteSmtpCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSmtpCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSmtpCredentialRequest) String() string
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
DeleteSmtpCredentialResponse wrapper for the DeleteSmtpCredential operation
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"`
}
func (response DeleteSmtpCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSmtpCredentialResponse) String() string
DeleteSwiftPasswordRequest wrapper for the DeleteSwiftPassword operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteSwiftPassword.go.html to see an example of how to use 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
}
func (request DeleteSwiftPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSwiftPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSwiftPasswordRequest) String() string
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
DeleteSwiftPasswordResponse wrapper for the DeleteSwiftPassword operation
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"`
}
func (response DeleteSwiftPasswordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSwiftPasswordResponse) String() string
DeleteTagDefaultRequest wrapper for the DeleteTagDefault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTagDefault.go.html to see an example of how to use 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
}
func (request DeleteTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTagDefaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTagDefaultRequest) String() string
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
DeleteTagDefaultResponse wrapper for the DeleteTagDefault operation
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"`
}
func (response DeleteTagDefaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTagDefaultResponse) String() string
DeleteTagNamespaceRequest wrapper for the DeleteTagNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTagNamespace.go.html to see an example of how to use 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
}
func (request DeleteTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTagNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTagNamespaceRequest) String() string
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
DeleteTagNamespaceResponse wrapper for the DeleteTagNamespace operation
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"`
}
func (response DeleteTagNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTagNamespaceResponse) String() string
DeleteTagRequest wrapper for the DeleteTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteTag.go.html to see an example of how to use 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
}
func (request DeleteTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTagRequest) String() string
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
DeleteTagResponse wrapper for the DeleteTag operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTagResponse) String() string
DeleteUserRequest wrapper for the DeleteUser operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/DeleteUser.go.html to see an example of how to use 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
}
func (request DeleteUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteUserRequest) String() string
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
DeleteUserResponse wrapper for the DeleteUser operation
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"`
}
func (response DeleteUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteUserResponse) String() string
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.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Domain) String() string
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
DomainLifecycleDetailsEnum Enum with underlying type: string
type DomainLifecycleDetailsEnum string
Set of constants representing the allowable values for DomainLifecycleDetailsEnum
const (
DomainLifecycleDetailsDeactivating DomainLifecycleDetailsEnum = "DEACTIVATING"
DomainLifecycleDetailsActivating DomainLifecycleDetailsEnum = "ACTIVATING"
DomainLifecycleDetailsUpdating DomainLifecycleDetailsEnum = "UPDATING"
)
func GetDomainLifecycleDetailsEnumValues() []DomainLifecycleDetailsEnum
GetDomainLifecycleDetailsEnumValues Enumerates the set of values for DomainLifecycleDetailsEnum
func GetMappingDomainLifecycleDetailsEnum(val string) (DomainLifecycleDetailsEnum, bool)
GetMappingDomainLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
DomainLifecycleStateEnum Enum with underlying type: string
type DomainLifecycleStateEnum string
Set of constants representing the allowable values for DomainLifecycleStateEnum
const (
DomainLifecycleStateCreating DomainLifecycleStateEnum = "CREATING"
DomainLifecycleStateActive DomainLifecycleStateEnum = "ACTIVE"
DomainLifecycleStateDeleting DomainLifecycleStateEnum = "DELETING"
DomainLifecycleStateInactive DomainLifecycleStateEnum = "INACTIVE"
)
func GetDomainLifecycleStateEnumValues() []DomainLifecycleStateEnum
GetDomainLifecycleStateEnumValues Enumerates the set of values for DomainLifecycleStateEnum
func GetMappingDomainLifecycleStateEnum(val string) (DomainLifecycleStateEnum, bool)
GetMappingDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DomainReplication (For tenancies that support identity domains) Identity domain replication states.
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"`
}
func (m DomainReplication) String() string
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
DomainReplicationStates (For tenancies that support identity domains) The identity domain replication log for all identity domains for a given region.
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"`
}
func (m DomainReplicationStates) String() string
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
DomainSummary (For tenancies that support identity domains) As the name suggests, a `DomainSummary` object contains information about a `Domain`.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DomainSummary) String() string
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
DomainSummaryLifecycleDetailsEnum Enum with underlying type: string
type DomainSummaryLifecycleDetailsEnum string
Set of constants representing the allowable values for DomainSummaryLifecycleDetailsEnum
const (
DomainSummaryLifecycleDetailsDeactivating DomainSummaryLifecycleDetailsEnum = "DEACTIVATING"
DomainSummaryLifecycleDetailsActivating DomainSummaryLifecycleDetailsEnum = "ACTIVATING"
DomainSummaryLifecycleDetailsUpdating DomainSummaryLifecycleDetailsEnum = "UPDATING"
)
func GetDomainSummaryLifecycleDetailsEnumValues() []DomainSummaryLifecycleDetailsEnum
GetDomainSummaryLifecycleDetailsEnumValues Enumerates the set of values for DomainSummaryLifecycleDetailsEnum
func GetMappingDomainSummaryLifecycleDetailsEnum(val string) (DomainSummaryLifecycleDetailsEnum, bool)
GetMappingDomainSummaryLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
DomainTypeEnum Enum with underlying type: string
type DomainTypeEnum string
Set of constants representing the allowable values for DomainTypeEnum
const (
DomainTypeDefault DomainTypeEnum = "DEFAULT"
DomainTypeSecondary DomainTypeEnum = "SECONDARY"
)
func GetDomainTypeEnumValues() []DomainTypeEnum
GetDomainTypeEnumValues Enumerates the set of values for DomainTypeEnum
func GetMappingDomainTypeEnum(val string) (DomainTypeEnum, bool)
GetMappingDomainTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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.oracle.com/iaas/Content/Identity/dynamicgroups/managingdynamicgroups.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m DynamicGroup) String() string
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
DynamicGroupLifecycleStateEnum Enum with underlying type: string
type DynamicGroupLifecycleStateEnum string
Set of constants representing the allowable values for DynamicGroupLifecycleStateEnum
const (
DynamicGroupLifecycleStateCreating DynamicGroupLifecycleStateEnum = "CREATING"
DynamicGroupLifecycleStateActive DynamicGroupLifecycleStateEnum = "ACTIVE"
DynamicGroupLifecycleStateInactive DynamicGroupLifecycleStateEnum = "INACTIVE"
DynamicGroupLifecycleStateDeleting DynamicGroupLifecycleStateEnum = "DELETING"
DynamicGroupLifecycleStateDeleted DynamicGroupLifecycleStateEnum = "DELETED"
)
func GetDynamicGroupLifecycleStateEnumValues() []DynamicGroupLifecycleStateEnum
GetDynamicGroupLifecycleStateEnumValues Enumerates the set of values for DynamicGroupLifecycleStateEnum
func GetMappingDynamicGroupLifecycleStateEnum(val string) (DynamicGroupLifecycleStateEnum, bool)
GetMappingDynamicGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
EnableReplicationToRegionDetails (For tenancies that support identity domains) Identity domain replication request packet.
type EnableReplicationToRegionDetails struct {
// A region to which you want identity domain replication to occur.
// See Regions and Availability Domains (https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm)
// for the full list of supported region names.
// Example: `us-phoenix-1`
ReplicaRegion *string `mandatory:"false" json:"replicaRegion"`
}
func (m EnableReplicationToRegionDetails) String() string
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
EnableReplicationToRegionRequest wrapper for the EnableReplicationToRegion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/EnableReplicationToRegion.go.html to see an example of how to use 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
}
func (request EnableReplicationToRegionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request EnableReplicationToRegionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EnableReplicationToRegionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EnableReplicationToRegionRequest) String() string
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
EnableReplicationToRegionResponse wrapper for the EnableReplicationToRegion operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response EnableReplicationToRegionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EnableReplicationToRegionResponse) String() string
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.
type EnumTagDefinitionValidator struct {
// The list of allowed values for a definedTag value.
Values []string `mandatory:"false" json:"values"`
}
func (m EnumTagDefinitionValidator) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m EnumTagDefinitionValidator) String() string
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
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.
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"`
}
func (m FaultDomain) String() string
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
FullyQualifiedScope The representation of 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"`
}
func (m FullyQualifiedScope) String() string
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
GenerateTotpSeedRequest wrapper for the GenerateTotpSeed operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GenerateTotpSeed.go.html to see an example of how to use 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
}
func (request GenerateTotpSeedRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateTotpSeedRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateTotpSeedRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateTotpSeedRequest) String() string
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
GenerateTotpSeedResponse wrapper for the GenerateTotpSeed operation
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"`
}
func (response GenerateTotpSeedResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateTotpSeedResponse) String() string
GetAuthenticationPolicyRequest wrapper for the GetAuthenticationPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetAuthenticationPolicy.go.html to see an example of how to use 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
}
func (request GetAuthenticationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAuthenticationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAuthenticationPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAuthenticationPolicyRequest) String() string
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
GetAuthenticationPolicyResponse wrapper for the GetAuthenticationPolicy operation
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"`
}
func (response GetAuthenticationPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAuthenticationPolicyResponse) String() string
GetCompartmentRequest wrapper for the GetCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetCompartment.go.html to see an example of how to use 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
}
func (request GetCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCompartmentRequest) String() string
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
GetCompartmentResponse wrapper for the GetCompartment operation
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"`
}
func (response GetCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCompartmentResponse) String() string
GetDomainRequest wrapper for the GetDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetDomain.go.html to see an example of how to use 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
}
func (request GetDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDomainRequest) String() string
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
GetDomainResponse wrapper for the GetDomain operation
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"`
}
func (response GetDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDomainResponse) String() string
GetDynamicGroupRequest wrapper for the GetDynamicGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetDynamicGroup.go.html to see an example of how to use 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
}
func (request GetDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDynamicGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDynamicGroupRequest) String() string
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
GetDynamicGroupResponse wrapper for the GetDynamicGroup operation
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"`
}
func (response GetDynamicGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDynamicGroupResponse) String() string
GetGroupRequest wrapper for the GetGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetGroup.go.html to see an example of how to use 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
}
func (request GetGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGroupRequest) String() string
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
GetGroupResponse wrapper for the GetGroup operation
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"`
}
func (response GetGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGroupResponse) String() string
GetIamWorkRequestRequest wrapper for the GetIamWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIamWorkRequest.go.html to see an example of how to use 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
}
func (request GetIamWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIamWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIamWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIamWorkRequestRequest) String() string
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
GetIamWorkRequestResponse wrapper for the GetIamWorkRequest operation
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"`
}
func (response GetIamWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIamWorkRequestResponse) String() string
GetIdentityProviderRequest wrapper for the GetIdentityProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIdentityProvider.go.html to see an example of how to use 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
}
func (request GetIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIdentityProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIdentityProviderRequest) String() string
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
GetIdentityProviderResponse wrapper for the GetIdentityProvider operation
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"`
}
func (response GetIdentityProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIdentityProviderResponse) String() string
GetIdpGroupMappingRequest wrapper for the GetIdpGroupMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetIdpGroupMapping.go.html to see an example of how to use 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
}
func (request GetIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIdpGroupMappingRequest) String() string
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
GetIdpGroupMappingResponse wrapper for the GetIdpGroupMapping operation
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"`
}
func (response GetIdpGroupMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIdpGroupMappingResponse) String() string
GetMfaTotpDeviceRequest wrapper for the GetMfaTotpDevice operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetMfaTotpDevice.go.html to see an example of how to use 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
}
func (request GetMfaTotpDeviceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetMfaTotpDeviceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetMfaTotpDeviceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetMfaTotpDeviceRequest) String() string
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
GetMfaTotpDeviceResponse wrapper for the GetMfaTotpDevice operation
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"`
}
func (response GetMfaTotpDeviceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetMfaTotpDeviceResponse) String() string
GetNetworkSourceRequest wrapper for the GetNetworkSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetNetworkSource.go.html to see an example of how to use 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
}
func (request GetNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetNetworkSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetNetworkSourceRequest) String() string
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
GetNetworkSourceResponse wrapper for the GetNetworkSource operation
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"`
}
func (response GetNetworkSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetNetworkSourceResponse) String() string
GetPolicyRequest wrapper for the GetPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetPolicy.go.html to see an example of how to use 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
}
func (request GetPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPolicyRequest) String() string
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
GetPolicyResponse wrapper for the GetPolicy operation
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"`
}
func (response GetPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPolicyResponse) String() string
GetStandardTagTemplateRequest wrapper for the GetStandardTagTemplate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetStandardTagTemplate.go.html to see an example of how to use 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
}
func (request GetStandardTagTemplateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetStandardTagTemplateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetStandardTagTemplateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetStandardTagTemplateRequest) String() string
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
GetStandardTagTemplateResponse wrapper for the GetStandardTagTemplate operation
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"`
}
func (response GetStandardTagTemplateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetStandardTagTemplateResponse) String() string
GetTagDefaultRequest wrapper for the GetTagDefault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTagDefault.go.html to see an example of how to use 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
}
func (request GetTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTagDefaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTagDefaultRequest) String() string
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
GetTagDefaultResponse wrapper for the GetTagDefault operation
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"`
}
func (response GetTagDefaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTagDefaultResponse) String() string
GetTagNamespaceRequest wrapper for the GetTagNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTagNamespace.go.html to see an example of how to use 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
}
func (request GetTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTagNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTagNamespaceRequest) String() string
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
GetTagNamespaceResponse wrapper for the GetTagNamespace operation
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"`
}
func (response GetTagNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTagNamespaceResponse) String() string
GetTagRequest wrapper for the GetTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTag.go.html to see an example of how to use 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
}
func (request GetTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTagRequest) String() string
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
GetTagResponse wrapper for the GetTag operation
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"`
}
func (response GetTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTagResponse) String() string
GetTaggingWorkRequestRequest wrapper for the GetTaggingWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTaggingWorkRequest.go.html to see an example of how to use 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
}
func (request GetTaggingWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTaggingWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTaggingWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTaggingWorkRequestRequest) String() string
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
GetTaggingWorkRequestResponse wrapper for the GetTaggingWorkRequest operation
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"`
}
func (response GetTaggingWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTaggingWorkRequestResponse) String() string
GetTenancyRequest wrapper for the GetTenancy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetTenancy.go.html to see an example of how to use 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
}
func (request GetTenancyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTenancyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTenancyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTenancyRequest) String() string
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
GetTenancyResponse wrapper for the GetTenancy operation
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"`
}
func (response GetTenancyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTenancyResponse) String() string
GetUserGroupMembershipRequest wrapper for the GetUserGroupMembership operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUserGroupMembership.go.html to see an example of how to use 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
}
func (request GetUserGroupMembershipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetUserGroupMembershipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetUserGroupMembershipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetUserGroupMembershipRequest) String() string
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
GetUserGroupMembershipResponse wrapper for the GetUserGroupMembership operation
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"`
}
func (response GetUserGroupMembershipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetUserGroupMembershipResponse) String() string
GetUserRequest wrapper for the GetUser operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUser.go.html to see an example of how to use 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
}
func (request GetUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetUserRequest) String() string
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
GetUserResponse wrapper for the GetUser operation
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"`
}
func (response GetUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetUserResponse) String() string
GetUserUIPasswordInformationRequest wrapper for the GetUserUIPasswordInformation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetUserUIPasswordInformation.go.html to see an example of how to use 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
}
func (request GetUserUIPasswordInformationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetUserUIPasswordInformationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetUserUIPasswordInformationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetUserUIPasswordInformationRequest) String() string
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
GetUserUIPasswordInformationResponse wrapper for the GetUserUIPasswordInformation operation
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"`
}
func (response GetUserUIPasswordInformationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetUserUIPasswordInformationResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/GetWorkRequest.go.html to see an example of how to use 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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
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"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Group) String() string
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
GroupLifecycleStateEnum Enum with underlying type: string
type GroupLifecycleStateEnum string
Set of constants representing the allowable values for GroupLifecycleStateEnum
const (
GroupLifecycleStateCreating GroupLifecycleStateEnum = "CREATING"
GroupLifecycleStateActive GroupLifecycleStateEnum = "ACTIVE"
GroupLifecycleStateInactive GroupLifecycleStateEnum = "INACTIVE"
GroupLifecycleStateDeleting GroupLifecycleStateEnum = "DELETING"
GroupLifecycleStateDeleted GroupLifecycleStateEnum = "DELETED"
)
func GetGroupLifecycleStateEnumValues() []GroupLifecycleStateEnum
GetGroupLifecycleStateEnumValues Enumerates the set of values for GroupLifecycleStateEnum
func GetMappingGroupLifecycleStateEnum(val string) (GroupLifecycleStateEnum, bool)
GetMappingGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IamWorkRequest (For tenancies that support identity domains) An IAM work request object that allows users to track the status of asynchronous API requests.
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"`
}
func (m IamWorkRequest) String() string
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
IamWorkRequestErrorSummary (For tenancies that support identity domains) An error encountered while executing an operation that is tracked by a IAM work request.
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"`
}
func (m IamWorkRequestErrorSummary) String() string
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
IamWorkRequestLogSummary (For tenancies that support identity domains) The log entity for a IAM work request.
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"`
}
func (m IamWorkRequestLogSummary) String() string
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
IamWorkRequestOperationTypeEnum Enum with underlying type: string
type IamWorkRequestOperationTypeEnum string
Set of constants representing the allowable values for IamWorkRequestOperationTypeEnum
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"
)
func GetIamWorkRequestOperationTypeEnumValues() []IamWorkRequestOperationTypeEnum
GetIamWorkRequestOperationTypeEnumValues Enumerates the set of values for IamWorkRequestOperationTypeEnum
func GetMappingIamWorkRequestOperationTypeEnum(val string) (IamWorkRequestOperationTypeEnum, bool)
GetMappingIamWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IamWorkRequestResource (For tenancies that support identity domains) A IAM work request resource entry.
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"`
}
func (m IamWorkRequestResource) String() string
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
IamWorkRequestResourceActionTypeEnum Enum with underlying type: string
type IamWorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for IamWorkRequestResourceActionTypeEnum
const (
IamWorkRequestResourceActionTypeCreated IamWorkRequestResourceActionTypeEnum = "CREATED"
IamWorkRequestResourceActionTypeUpdated IamWorkRequestResourceActionTypeEnum = "UPDATED"
IamWorkRequestResourceActionTypeDeleted IamWorkRequestResourceActionTypeEnum = "DELETED"
IamWorkRequestResourceActionTypeRelated IamWorkRequestResourceActionTypeEnum = "RELATED"
IamWorkRequestResourceActionTypeInProgress IamWorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)
func GetIamWorkRequestResourceActionTypeEnumValues() []IamWorkRequestResourceActionTypeEnum
GetIamWorkRequestResourceActionTypeEnumValues Enumerates the set of values for IamWorkRequestResourceActionTypeEnum
func GetMappingIamWorkRequestResourceActionTypeEnum(val string) (IamWorkRequestResourceActionTypeEnum, bool)
GetMappingIamWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IamWorkRequestStatusEnum Enum with underlying type: string
type IamWorkRequestStatusEnum string
Set of constants representing the allowable values for IamWorkRequestStatusEnum
const (
IamWorkRequestStatusAccepted IamWorkRequestStatusEnum = "ACCEPTED"
IamWorkRequestStatusInProgress IamWorkRequestStatusEnum = "IN_PROGRESS"
IamWorkRequestStatusFailed IamWorkRequestStatusEnum = "FAILED"
IamWorkRequestStatusSucceeded IamWorkRequestStatusEnum = "SUCCEEDED"
IamWorkRequestStatusCanceling IamWorkRequestStatusEnum = "CANCELING"
IamWorkRequestStatusCanceled IamWorkRequestStatusEnum = "CANCELED"
)
func GetIamWorkRequestStatusEnumValues() []IamWorkRequestStatusEnum
GetIamWorkRequestStatusEnumValues Enumerates the set of values for IamWorkRequestStatusEnum
func GetMappingIamWorkRequestStatusEnum(val string) (IamWorkRequestStatusEnum, bool)
GetMappingIamWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
IamWorkRequestSummary (For tenancies that support identity domains) The IAM work request summary. Tracks the status of asynchronous operations.
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"`
}
func (m IamWorkRequestSummary) String() string
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
IamWorkRequestSummaryOperationTypeEnum Enum with underlying type: string
type IamWorkRequestSummaryOperationTypeEnum string
Set of constants representing the allowable values for IamWorkRequestSummaryOperationTypeEnum
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"
)
func GetIamWorkRequestSummaryOperationTypeEnumValues() []IamWorkRequestSummaryOperationTypeEnum
GetIamWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for IamWorkRequestSummaryOperationTypeEnum
func GetMappingIamWorkRequestSummaryOperationTypeEnum(val string) (IamWorkRequestSummaryOperationTypeEnum, bool)
GetMappingIamWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IamWorkRequestSummaryStatusEnum Enum with underlying type: string
type IamWorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for IamWorkRequestSummaryStatusEnum
const (
IamWorkRequestSummaryStatusAccepted IamWorkRequestSummaryStatusEnum = "ACCEPTED"
IamWorkRequestSummaryStatusInProgress IamWorkRequestSummaryStatusEnum = "IN_PROGRESS"
IamWorkRequestSummaryStatusFailed IamWorkRequestSummaryStatusEnum = "FAILED"
IamWorkRequestSummaryStatusSucceeded IamWorkRequestSummaryStatusEnum = "SUCCEEDED"
IamWorkRequestSummaryStatusCanceling IamWorkRequestSummaryStatusEnum = "CANCELING"
IamWorkRequestSummaryStatusCanceled IamWorkRequestSummaryStatusEnum = "CANCELED"
)
func GetIamWorkRequestSummaryStatusEnumValues() []IamWorkRequestSummaryStatusEnum
GetIamWorkRequestSummaryStatusEnumValues Enumerates the set of values for IamWorkRequestSummaryStatusEnum
func GetMappingIamWorkRequestSummaryStatusEnum(val string) (IamWorkRequestSummaryStatusEnum, bool)
GetMappingIamWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
IdentityClient a client for Identity
type IdentityClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) AddTagDefaultLock(ctx context.Context, request AddTagDefaultLockRequest) (response AddTagDefaultLockResponse, err error)
AddTagDefaultLock Add a resource lock to a tag default.
Click https://docs.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 (client IdentityClient) AddTagNamespaceLock(ctx context.Context, request AddTagNamespaceLockRequest) (response AddTagNamespaceLockResponse, err error)
AddTagNamespaceLock Add a resource lock to a tag namespace.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/Content/Identity/regions/managingregions.htm#Home). This operation creates a WorkRequest. Use the GetWorkRequest API to monitor the status of the bulk action.
Click https://docs.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 (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:
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.
Click https://docs.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 (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:
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.
Click https://docs.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 (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.oracle.com/iaas/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.
Click https://docs.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 (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:
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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/Content/Identity/policyreference/iampolicyreference.htm). Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
Click https://docs.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 (client *IdentityClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.oracle.com/iaas/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.
Click https://docs.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 (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.oracle.com/iaas/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.oracle.com/iaas/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.
Click https://docs.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 (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.oracle.com/iaas/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.
Click https://docs.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 (client IdentityClient) CreateDbCredential(ctx context.Context, request CreateDbCredentialRequest) (response CreateDbCredentialResponse, err error)
CreateDbCredential Creates a new DB credential for the specified user.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/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.oracle.com/iaas/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.
Click https://docs.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 (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.oracle.com/iaas/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.oracle.com/iaas/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.
Click https://docs.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 (client IdentityClient) CreateIdentityProvider(ctx context.Context, request CreateIdentityProviderRequest) (response CreateIdentityProviderResponse, err error)
CreateIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Creates a new identity provider in your tenancy. For more information, see Identity Providers and Federation (https://docs.oracle.com/iaas/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.oracle.com/iaas/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.
Click https://docs.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 (client IdentityClient) CreateIdpGroupMapping(ctx context.Context, request CreateIdpGroupMappingRequest) (response CreateIdpGroupMappingResponse, err error)
CreateIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Creates a single mapping between an IdP group and an IAM Service Group.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).
Click https://docs.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 (client IdentityClient) CreateOAuthClientCredential(ctx context.Context, request CreateOAuthClientCredentialRequest) (response CreateOAuthClientCredentialResponse, err error)
CreateOAuthClientCredential Creates Oauth token for the user
Click https://docs.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 (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.oracle.com/iaas/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).
Click https://docs.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 (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.oracle.com/iaas/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.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm) and Common Policies (https://docs.oracle.com/iaas/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.
Click https://docs.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 (client IdentityClient) CreateRegionSubscription(ctx context.Context, request CreateRegionSubscriptionRequest) (response CreateRegionSubscriptionResponse, err error)
CreateRegionSubscription Creates a subscription to a region for a tenancy.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm) and also UploadApiKey). **Important:** Make sure to inform the new user which compartment(s) they have access to.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) DeleteAuthToken(ctx context.Context, request DeleteAuthTokenRequest) (response DeleteAuthTokenResponse, err error)
DeleteAuthToken Deletes the specified auth token for the specified user.
Click https://docs.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 (client IdentityClient) DeleteCompartment(ctx context.Context, request DeleteCompartmentRequest) (response DeleteCompartmentResponse, err error)
DeleteCompartment Deletes the specified compartment. The compartment must be empty.
Click https://docs.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 (client IdentityClient) DeleteCustomerSecretKey(ctx context.Context, request DeleteCustomerSecretKeyRequest) (response DeleteCustomerSecretKeyResponse, err error)
DeleteCustomerSecretKey Deletes the specified secret key for the specified user.
Click https://docs.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 (client IdentityClient) DeleteDbCredential(ctx context.Context, request DeleteDbCredentialRequest) (response DeleteDbCredentialResponse, err error)
DeleteDbCredential Deletes the specified DB credential for the specified user.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) DeleteDynamicGroup(ctx context.Context, request DeleteDynamicGroupRequest) (response DeleteDynamicGroupResponse, err error)
DeleteDynamicGroup Deletes the specified dynamic group.
Click https://docs.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 (client IdentityClient) DeleteGroup(ctx context.Context, request DeleteGroupRequest) (response DeleteGroupResponse, err error)
DeleteGroup Deletes the specified group. The group must be empty.
Click https://docs.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 (client IdentityClient) DeleteIdentityProvider(ctx context.Context, request DeleteIdentityProviderRequest) (response DeleteIdentityProviderResponse, err error)
DeleteIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Deletes the specified identity provider. The identity provider must not have any group mappings (see IdpGroupMapping).
Click https://docs.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 (client IdentityClient) DeleteIdpGroupMapping(ctx context.Context, request DeleteIdpGroupMappingRequest) (response DeleteIdpGroupMappingResponse, err error)
DeleteIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Deletes the specified group mapping.
Click https://docs.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 (client IdentityClient) DeleteMfaTotpDevice(ctx context.Context, request DeleteMfaTotpDeviceRequest) (response DeleteMfaTotpDeviceResponse, err error)
DeleteMfaTotpDevice Deletes the specified MFA TOTP device for the specified user.
Click https://docs.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 (client IdentityClient) DeleteNetworkSource(ctx context.Context, request DeleteNetworkSourceRequest) (response DeleteNetworkSourceResponse, err error)
DeleteNetworkSource Deletes the specified network source.
Click https://docs.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 (client IdentityClient) DeleteOAuthClientCredential(ctx context.Context, request DeleteOAuthClientCredentialRequest) (response DeleteOAuthClientCredentialResponse, err error)
DeleteOAuthClientCredential Delete Oauth token for the user
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) DeleteSmtpCredential(ctx context.Context, request DeleteSmtpCredentialRequest) (response DeleteSmtpCredentialResponse, err error)
DeleteSmtpCredential Deletes the specified SMTP credential for the specified user.
Click https://docs.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 (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.
Click https://docs.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 (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:
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.
Click https://docs.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 (client IdentityClient) DeleteTagDefault(ctx context.Context, request DeleteTagDefaultRequest) (response DeleteTagDefaultResponse, err error)
DeleteTagDefault Deletes the the specified tag default.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) GenerateTotpSeed(ctx context.Context, request GenerateTotpSeedRequest) (response GenerateTotpSeedResponse, err error)
GenerateTotpSeed Generate seed for the MFA TOTP device.
Click https://docs.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 (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).
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) GetDynamicGroup(ctx context.Context, request GetDynamicGroupRequest) (response GetDynamicGroupResponse, err error)
GetDynamicGroup Gets the specified dynamic group's information.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) GetIdentityProvider(ctx context.Context, request GetIdentityProviderRequest) (response GetIdentityProviderResponse, err error)
GetIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Gets the specified identity provider's information.
Click https://docs.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 (client IdentityClient) GetIdpGroupMapping(ctx context.Context, request GetIdpGroupMappingRequest) (response GetIdpGroupMappingResponse, err error)
GetIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Gets the specified group mapping.
Click https://docs.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 (client IdentityClient) GetMfaTotpDevice(ctx context.Context, request GetMfaTotpDeviceRequest) (response GetMfaTotpDeviceResponse, err error)
GetMfaTotpDevice Get the specified MFA TOTP device for the specified user.
Click https://docs.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 (client IdentityClient) GetNetworkSource(ctx context.Context, request GetNetworkSourceRequest) (response GetNetworkSourceResponse, err error)
GetNetworkSource Gets the specified network source's information.
Click https://docs.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 (client IdentityClient) GetPolicy(ctx context.Context, request GetPolicyRequest) (response GetPolicyResponse, err error)
GetPolicy Gets the specified policy's information.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) GetTag(ctx context.Context, request GetTagRequest) (response GetTagResponse, err error)
GetTag Gets the specified tag's information.
Click https://docs.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 (client IdentityClient) GetTagDefault(ctx context.Context, request GetTagDefaultRequest) (response GetTagDefaultResponse, err error)
GetTagDefault Retrieves the specified tag default.
Click https://docs.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 (client IdentityClient) GetTagNamespace(ctx context.Context, request GetTagNamespaceRequest) (response GetTagNamespaceResponse, err error)
GetTagNamespace Gets the specified tag namespace's information.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) GetTenancy(ctx context.Context, request GetTenancyRequest) (response GetTenancyResponse, err error)
GetTenancy Get the specified tenancy's information.
Click https://docs.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 (client IdentityClient) GetUser(ctx context.Context, request GetUserRequest) (response GetUserResponse, err error)
GetUser Gets the specified user's information.
Click https://docs.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 (client IdentityClient) GetUserGroupMembership(ctx context.Context, request GetUserGroupMembershipRequest) (response GetUserGroupMembershipResponse, err error)
GetUserGroupMembership Gets the specified UserGroupMembership's information.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/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.
Click https://docs.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 (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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types, such as buckets, require you to provide other identifying information.
Click https://docs.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 (client IdentityClient) ListBulkEditTagsResourceTypes(ctx context.Context, request ListBulkEditTagsResourceTypesRequest) (response ListBulkEditTagsResourceTypesResponse, err error)
ListBulkEditTagsResourceTypes Lists the resource types that support bulk tag editing.
Click https://docs.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 (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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (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.oracle.com/iaas/Content/Tagging/Tasks/usingcosttrackingtags.htm).
Click https://docs.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 (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.
Click https://docs.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 (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
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) ListIdentityProviderGroups(ctx context.Context, request ListIdentityProviderGroupsRequest) (response ListIdentityProviderGroupsResponse, err error)
ListIdentityProviderGroups **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Lists the identity provider groups.
Click https://docs.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 (client IdentityClient) ListIdentityProviders(ctx context.Context, request ListIdentityProvidersRequest) (response ListIdentityProvidersResponse, err error)
ListIdentityProviders **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (client IdentityClient) ListIdpGroupMappings(ctx context.Context, request ListIdpGroupMappingsRequest) (response ListIdpGroupMappingsResponse, err error)
ListIdpGroupMappings **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Lists the group mappings for the specified identity provider.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (client IdentityClient) ListOAuthClientCredentials(ctx context.Context, request ListOAuthClientCredentialsRequest) (response ListOAuthClientCredentialsResponse, err error)
ListOAuthClientCredentials List of Oauth tokens for the user
Click https://docs.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 (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.oracle.com/iaas/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.
Click https://docs.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 (client IdentityClient) ListRegionSubscriptions(ctx context.Context, request ListRegionSubscriptionsRequest) (response ListRegionSubscriptionsResponse, err error)
ListRegionSubscriptions Lists the region subscriptions for the specified tenancy.
Click https://docs.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 (client IdentityClient) ListRegions(ctx context.Context) (response ListRegionsResponse, err error)
ListRegions Lists all the regions offered by Oracle Cloud Infrastructure.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) ListStandardTagNamespaces(ctx context.Context, request ListStandardTagNamespacesRequest) (response ListStandardTagNamespacesResponse, err error)
ListStandardTagNamespaces Lists available standard tag namespaces that users can create.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) ListTagDefaults(ctx context.Context, request ListTagDefaultsRequest) (response ListTagDefaultsResponse, err error)
ListTagDefaults Lists the tag defaults for tag definitions in the specified compartment.
Click https://docs.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 (client IdentityClient) ListTagNamespaces(ctx context.Context, request ListTagNamespacesRequest) (response ListTagNamespacesResponse, err error)
ListTagNamespaces Lists the tag namespaces in the specified compartment.
Click https://docs.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 (client IdentityClient) ListTaggingWorkRequestErrors(ctx context.Context, request ListTaggingWorkRequestErrorsRequest) (response ListTaggingWorkRequestErrorsResponse, err error)
ListTaggingWorkRequestErrors Gets the errors for a work request.
Click https://docs.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 (client IdentityClient) ListTaggingWorkRequestLogs(ctx context.Context, request ListTaggingWorkRequestLogsRequest) (response ListTaggingWorkRequestLogsResponse, err error)
ListTaggingWorkRequestLogs Gets the logs for a work request.
Click https://docs.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 (client IdentityClient) ListTaggingWorkRequests(ctx context.Context, request ListTaggingWorkRequestsRequest) (response ListTaggingWorkRequestsResponse, err error)
ListTaggingWorkRequests Lists the tagging work requests in compartment.
Click https://docs.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 (client IdentityClient) ListTags(ctx context.Context, request ListTagsRequest) (response ListTagsResponse, err error)
ListTags Lists the tag definitions in the specified tag namespace.
Click https://docs.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 (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.oracle.com/iaas/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.
Click https://docs.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 (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.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).
Click https://docs.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 (client IdentityClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in compartment.
Click https://docs.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 (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.oracle.com/iaas/Content/Identity/compartments/managingcompartments.htm#MoveCompartment).
Click https://docs.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 (client IdentityClient) RecoverCompartment(ctx context.Context, request RecoverCompartmentRequest) (response RecoverCompartmentResponse, err error)
RecoverCompartment Recover the compartment from DELETED state to ACTIVE state.
Click https://docs.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 (client IdentityClient) RemoveTagDefaultLock(ctx context.Context, request RemoveTagDefaultLockRequest) (response RemoveTagDefaultLockResponse, err error)
RemoveTagDefaultLock Remove a resource lock from a tag default.
Click https://docs.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 (client IdentityClient) RemoveTagNamespaceLock(ctx context.Context, request RemoveTagNamespaceLockRequest) (response RemoveTagNamespaceLockResponse, err error)
RemoveTagNamespaceLock Remove a resource lock from a tag namespace.
Click https://docs.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 (client IdentityClient) RemoveUserFromGroup(ctx context.Context, request RemoveUserFromGroupRequest) (response RemoveUserFromGroupResponse, err error)
RemoveUserFromGroup Removes a user from a group by deleting the corresponding `UserGroupMembership`.
Click https://docs.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 (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.
Click https://docs.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 (client *IdentityClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client IdentityClient) UpdateAuthToken(ctx context.Context, request UpdateAuthTokenRequest) (response UpdateAuthTokenResponse, err error)
UpdateAuthToken Updates the specified auth token's description.
Click https://docs.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 (client IdentityClient) UpdateAuthenticationPolicy(ctx context.Context, request UpdateAuthenticationPolicyRequest) (response UpdateAuthenticationPolicyResponse, err error)
UpdateAuthenticationPolicy Updates authentication policy for the specified tenancy.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) UpdateCustomerSecretKey(ctx context.Context, request UpdateCustomerSecretKeyRequest) (response UpdateCustomerSecretKeyResponse, err error)
UpdateCustomerSecretKey Updates the specified secret key's description.
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) UpdateDynamicGroup(ctx context.Context, request UpdateDynamicGroupRequest) (response UpdateDynamicGroupResponse, err error)
UpdateDynamicGroup Updates the specified dynamic group.
Click https://docs.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 (client IdentityClient) UpdateGroup(ctx context.Context, request UpdateGroupRequest) (response UpdateGroupResponse, err error)
UpdateGroup Updates the specified group.
Click https://docs.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 (client IdentityClient) UpdateIdentityProvider(ctx context.Context, request UpdateIdentityProviderRequest) (response UpdateIdentityProviderResponse, err error)
UpdateIdentityProvider **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Updates the specified identity provider.
Click https://docs.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 (client IdentityClient) UpdateIdpGroupMapping(ctx context.Context, request UpdateIdpGroupMappingRequest) (response UpdateIdpGroupMappingResponse, err error)
UpdateIdpGroupMapping **Deprecated.** For more information, see Deprecated IAM Service APIs (https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). Updates the specified group mapping.
Click https://docs.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 (client IdentityClient) UpdateNetworkSource(ctx context.Context, request UpdateNetworkSourceRequest) (response UpdateNetworkSourceResponse, err error)
UpdateNetworkSource Updates the specified network source.
Click https://docs.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 (client IdentityClient) UpdateOAuthClientCredential(ctx context.Context, request UpdateOAuthClientCredentialRequest) (response UpdateOAuthClientCredentialResponse, err error)
UpdateOAuthClientCredential Updates Oauth token for the user
Click https://docs.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 (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.
Click https://docs.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 (client IdentityClient) UpdateSmtpCredential(ctx context.Context, request UpdateSmtpCredentialRequest) (response UpdateSmtpCredentialResponse, err error)
UpdateSmtpCredential Updates the specified SMTP credential's description.
Click https://docs.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 (client IdentityClient) UpdateSwiftPassword(ctx context.Context, request UpdateSwiftPasswordRequest) (response UpdateSwiftPasswordResponse, err error)
UpdateSwiftPassword **Deprecated. Use UpdateAuthToken instead.** Updates the specified Swift password's description.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys). You can't add a namespace with the same name as a retired namespace in the same tenancy.
Click https://docs.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 (client IdentityClient) UpdateUser(ctx context.Context, request UpdateUserRequest) (response UpdateUserResponse, err error)
UpdateUser Updates the description of the specified user.
Click https://docs.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 (client IdentityClient) UpdateUserCapabilities(ctx context.Context, request UpdateUserCapabilitiesRequest) (response UpdateUserCapabilitiesResponse, err error)
UpdateUserCapabilities Updates the capabilities of the specified user.
Click https://docs.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 (client IdentityClient) UpdateUserState(ctx context.Context, request UpdateUserStateRequest) (response UpdateUserStateResponse, err error)
UpdateUserState Updates the state of the specified user.
Click https://docs.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 (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.
Click https://docs.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()
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.oracle.com/iaas/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.oracle.com/iaas/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 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
GetDefinedTags() map[string]map[string]interface{}
}
IdentityProviderGroupSummary A group created in an identity provider that can be mapped to a group in OCI
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"`
}
func (m IdentityProviderGroupSummary) String() string
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
IdentityProviderLifecycleStateEnum Enum with underlying type: string
type IdentityProviderLifecycleStateEnum string
Set of constants representing the allowable values for IdentityProviderLifecycleStateEnum
const (
IdentityProviderLifecycleStateCreating IdentityProviderLifecycleStateEnum = "CREATING"
IdentityProviderLifecycleStateActive IdentityProviderLifecycleStateEnum = "ACTIVE"
IdentityProviderLifecycleStateInactive IdentityProviderLifecycleStateEnum = "INACTIVE"
IdentityProviderLifecycleStateDeleting IdentityProviderLifecycleStateEnum = "DELETING"
IdentityProviderLifecycleStateDeleted IdentityProviderLifecycleStateEnum = "DELETED"
)
func GetIdentityProviderLifecycleStateEnumValues() []IdentityProviderLifecycleStateEnum
GetIdentityProviderLifecycleStateEnumValues Enumerates the set of values for IdentityProviderLifecycleStateEnum
func GetMappingIdentityProviderLifecycleStateEnum(val string) (IdentityProviderLifecycleStateEnum, bool)
GetMappingIdentityProviderLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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.oracle.com/iaas/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.
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"`
}
func (m IdpGroupMapping) String() string
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
IdpGroupMappingLifecycleStateEnum Enum with underlying type: string
type IdpGroupMappingLifecycleStateEnum string
Set of constants representing the allowable values for IdpGroupMappingLifecycleStateEnum
const (
IdpGroupMappingLifecycleStateCreating IdpGroupMappingLifecycleStateEnum = "CREATING"
IdpGroupMappingLifecycleStateActive IdpGroupMappingLifecycleStateEnum = "ACTIVE"
IdpGroupMappingLifecycleStateInactive IdpGroupMappingLifecycleStateEnum = "INACTIVE"
IdpGroupMappingLifecycleStateDeleting IdpGroupMappingLifecycleStateEnum = "DELETING"
IdpGroupMappingLifecycleStateDeleted IdpGroupMappingLifecycleStateEnum = "DELETED"
)
func GetIdpGroupMappingLifecycleStateEnumValues() []IdpGroupMappingLifecycleStateEnum
GetIdpGroupMappingLifecycleStateEnumValues Enumerates the set of values for IdpGroupMappingLifecycleStateEnum
func GetMappingIdpGroupMappingLifecycleStateEnum(val string) (IdpGroupMappingLifecycleStateEnum, bool)
GetMappingIdpGroupMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ImportStandardTagsDetails The representation of 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"`
}
func (m ImportStandardTagsDetails) String() string
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
ImportStandardTagsRequest wrapper for the ImportStandardTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ImportStandardTags.go.html to see an example of how to use 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
}
func (request ImportStandardTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportStandardTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportStandardTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportStandardTagsRequest) String() string
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
ImportStandardTagsResponse wrapper for the ImportStandardTags operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ImportStandardTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportStandardTagsResponse) String() string
ListAllowedDomainLicenseTypesRequest wrapper for the ListAllowedDomainLicenseTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAllowedDomainLicenseTypes.go.html to see an example of how to use 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
}
func (request ListAllowedDomainLicenseTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAllowedDomainLicenseTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAllowedDomainLicenseTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAllowedDomainLicenseTypesRequest) String() string
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
ListAllowedDomainLicenseTypesResponse wrapper for the ListAllowedDomainLicenseTypes operation
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"`
}
func (response ListAllowedDomainLicenseTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAllowedDomainLicenseTypesResponse) String() string
ListApiKeysRequest wrapper for the ListApiKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListApiKeys.go.html to see an example of how to use 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
}
func (request ListApiKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApiKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApiKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApiKeysRequest) String() string
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
ListApiKeysResponse wrapper for the ListApiKeys operation
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"`
}
func (response ListApiKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApiKeysResponse) String() string
ListAuthTokensRequest wrapper for the ListAuthTokens operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAuthTokens.go.html to see an example of how to use 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
}
func (request ListAuthTokensRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAuthTokensRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAuthTokensRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAuthTokensRequest) String() string
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
ListAuthTokensResponse wrapper for the ListAuthTokens operation
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"`
}
func (response ListAuthTokensResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAuthTokensResponse) String() string
ListAvailabilityDomainsRequest wrapper for the ListAvailabilityDomains operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListAvailabilityDomains.go.html to see an example of how to use 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
}
func (request ListAvailabilityDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAvailabilityDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAvailabilityDomainsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAvailabilityDomainsRequest) String() string
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
ListAvailabilityDomainsResponse wrapper for the ListAvailabilityDomains operation
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"`
}
func (response ListAvailabilityDomainsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAvailabilityDomainsResponse) String() string
ListBulkActionResourceTypesBulkActionTypeEnum Enum with underlying type: string
type ListBulkActionResourceTypesBulkActionTypeEnum string
Set of constants representing the allowable values for ListBulkActionResourceTypesBulkActionTypeEnum
const (
ListBulkActionResourceTypesBulkActionTypeMoveResources ListBulkActionResourceTypesBulkActionTypeEnum = "BULK_MOVE_RESOURCES"
ListBulkActionResourceTypesBulkActionTypeDeleteResources ListBulkActionResourceTypesBulkActionTypeEnum = "BULK_DELETE_RESOURCES"
)
func GetListBulkActionResourceTypesBulkActionTypeEnumValues() []ListBulkActionResourceTypesBulkActionTypeEnum
GetListBulkActionResourceTypesBulkActionTypeEnumValues Enumerates the set of values for ListBulkActionResourceTypesBulkActionTypeEnum
func GetMappingListBulkActionResourceTypesBulkActionTypeEnum(val string) (ListBulkActionResourceTypesBulkActionTypeEnum, bool)
GetMappingListBulkActionResourceTypesBulkActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListBulkActionResourceTypesRequest wrapper for the ListBulkActionResourceTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListBulkActionResourceTypes.go.html to see an example of how to use 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
}
func (request ListBulkActionResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBulkActionResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBulkActionResourceTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBulkActionResourceTypesRequest) String() string
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
ListBulkActionResourceTypesResponse wrapper for the ListBulkActionResourceTypes operation
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"`
}
func (response ListBulkActionResourceTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBulkActionResourceTypesResponse) String() string
ListBulkEditTagsResourceTypesRequest wrapper for the ListBulkEditTagsResourceTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListBulkEditTagsResourceTypes.go.html to see an example of how to use 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
}
func (request ListBulkEditTagsResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBulkEditTagsResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBulkEditTagsResourceTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBulkEditTagsResourceTypesRequest) String() string
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
ListBulkEditTagsResourceTypesResponse wrapper for the ListBulkEditTagsResourceTypes operation
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"`
}
func (response ListBulkEditTagsResourceTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBulkEditTagsResourceTypesResponse) String() string
ListCompartmentsAccessLevelEnum Enum with underlying type: string
type ListCompartmentsAccessLevelEnum string
Set of constants representing the allowable values for ListCompartmentsAccessLevelEnum
const (
ListCompartmentsAccessLevelAny ListCompartmentsAccessLevelEnum = "ANY"
ListCompartmentsAccessLevelAccessible ListCompartmentsAccessLevelEnum = "ACCESSIBLE"
)
func GetListCompartmentsAccessLevelEnumValues() []ListCompartmentsAccessLevelEnum
GetListCompartmentsAccessLevelEnumValues Enumerates the set of values for ListCompartmentsAccessLevelEnum
func GetMappingListCompartmentsAccessLevelEnum(val string) (ListCompartmentsAccessLevelEnum, bool)
GetMappingListCompartmentsAccessLevelEnum performs case Insensitive comparison on enum value and return the desired enum
ListCompartmentsRequest wrapper for the ListCompartments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCompartments.go.html to see an example of how to use 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
}
func (request ListCompartmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCompartmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCompartmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCompartmentsRequest) String() string
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
ListCompartmentsResponse wrapper for the ListCompartments operation
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"`
}
func (response ListCompartmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCompartmentsResponse) String() string
ListCompartmentsSortByEnum Enum with underlying type: string
type ListCompartmentsSortByEnum string
Set of constants representing the allowable values for ListCompartmentsSortByEnum
const (
ListCompartmentsSortByTimecreated ListCompartmentsSortByEnum = "TIMECREATED"
ListCompartmentsSortByName ListCompartmentsSortByEnum = "NAME"
)
func GetListCompartmentsSortByEnumValues() []ListCompartmentsSortByEnum
GetListCompartmentsSortByEnumValues Enumerates the set of values for ListCompartmentsSortByEnum
func GetMappingListCompartmentsSortByEnum(val string) (ListCompartmentsSortByEnum, bool)
GetMappingListCompartmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCompartmentsSortOrderEnum Enum with underlying type: string
type ListCompartmentsSortOrderEnum string
Set of constants representing the allowable values for ListCompartmentsSortOrderEnum
const (
ListCompartmentsSortOrderAsc ListCompartmentsSortOrderEnum = "ASC"
ListCompartmentsSortOrderDesc ListCompartmentsSortOrderEnum = "DESC"
)
func GetListCompartmentsSortOrderEnumValues() []ListCompartmentsSortOrderEnum
GetListCompartmentsSortOrderEnumValues Enumerates the set of values for ListCompartmentsSortOrderEnum
func GetMappingListCompartmentsSortOrderEnum(val string) (ListCompartmentsSortOrderEnum, bool)
GetMappingListCompartmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCostTrackingTagsRequest wrapper for the ListCostTrackingTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCostTrackingTags.go.html to see an example of how to use 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
}
func (request ListCostTrackingTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCostTrackingTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCostTrackingTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCostTrackingTagsRequest) String() string
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
ListCostTrackingTagsResponse wrapper for the ListCostTrackingTags operation
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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListCostTrackingTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCostTrackingTagsResponse) String() string
ListCustomerSecretKeysRequest wrapper for the ListCustomerSecretKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListCustomerSecretKeys.go.html to see an example of how to use 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
}
func (request ListCustomerSecretKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCustomerSecretKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCustomerSecretKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCustomerSecretKeysRequest) String() string
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
ListCustomerSecretKeysResponse wrapper for the ListCustomerSecretKeys operation
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"`
}
func (response ListCustomerSecretKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCustomerSecretKeysResponse) String() string
ListDbCredentialsRequest wrapper for the ListDbCredentials operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDbCredentials.go.html to see an example of how to use 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
}
func (request ListDbCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDbCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDbCredentialsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDbCredentialsRequest) String() string
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
ListDbCredentialsResponse wrapper for the ListDbCredentials operation
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"`
}
func (response ListDbCredentialsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDbCredentialsResponse) String() string
ListDbCredentialsSortByEnum Enum with underlying type: string
type ListDbCredentialsSortByEnum string
Set of constants representing the allowable values for ListDbCredentialsSortByEnum
const (
ListDbCredentialsSortByTimecreated ListDbCredentialsSortByEnum = "TIMECREATED"
ListDbCredentialsSortByName ListDbCredentialsSortByEnum = "NAME"
)
func GetListDbCredentialsSortByEnumValues() []ListDbCredentialsSortByEnum
GetListDbCredentialsSortByEnumValues Enumerates the set of values for ListDbCredentialsSortByEnum
func GetMappingListDbCredentialsSortByEnum(val string) (ListDbCredentialsSortByEnum, bool)
GetMappingListDbCredentialsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDbCredentialsSortOrderEnum Enum with underlying type: string
type ListDbCredentialsSortOrderEnum string
Set of constants representing the allowable values for ListDbCredentialsSortOrderEnum
const (
ListDbCredentialsSortOrderAsc ListDbCredentialsSortOrderEnum = "ASC"
ListDbCredentialsSortOrderDesc ListDbCredentialsSortOrderEnum = "DESC"
)
func GetListDbCredentialsSortOrderEnumValues() []ListDbCredentialsSortOrderEnum
GetListDbCredentialsSortOrderEnumValues Enumerates the set of values for ListDbCredentialsSortOrderEnum
func GetMappingListDbCredentialsSortOrderEnum(val string) (ListDbCredentialsSortOrderEnum, bool)
GetMappingListDbCredentialsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainsRequest wrapper for the ListDomains operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDomains.go.html to see an example of how to use 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
}
func (request ListDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDomainsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDomainsRequest) String() string
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
ListDomainsResponse wrapper for the ListDomains operation
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"`
}
func (response ListDomainsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDomainsResponse) String() string
ListDomainsSortByEnum Enum with underlying type: string
type ListDomainsSortByEnum string
Set of constants representing the allowable values for ListDomainsSortByEnum
const (
ListDomainsSortByTimecreated ListDomainsSortByEnum = "TIMECREATED"
ListDomainsSortByName ListDomainsSortByEnum = "NAME"
)
func GetListDomainsSortByEnumValues() []ListDomainsSortByEnum
GetListDomainsSortByEnumValues Enumerates the set of values for ListDomainsSortByEnum
func GetMappingListDomainsSortByEnum(val string) (ListDomainsSortByEnum, bool)
GetMappingListDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDomainsSortOrderEnum Enum with underlying type: string
type ListDomainsSortOrderEnum string
Set of constants representing the allowable values for ListDomainsSortOrderEnum
const (
ListDomainsSortOrderAsc ListDomainsSortOrderEnum = "ASC"
ListDomainsSortOrderDesc ListDomainsSortOrderEnum = "DESC"
)
func GetListDomainsSortOrderEnumValues() []ListDomainsSortOrderEnum
GetListDomainsSortOrderEnumValues Enumerates the set of values for ListDomainsSortOrderEnum
func GetMappingListDomainsSortOrderEnum(val string) (ListDomainsSortOrderEnum, bool)
GetMappingListDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDynamicGroupsRequest wrapper for the ListDynamicGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListDynamicGroups.go.html to see an example of how to use 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
}
func (request ListDynamicGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDynamicGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDynamicGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDynamicGroupsRequest) String() string
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
ListDynamicGroupsResponse wrapper for the ListDynamicGroups operation
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"`
}
func (response ListDynamicGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDynamicGroupsResponse) String() string
ListDynamicGroupsSortByEnum Enum with underlying type: string
type ListDynamicGroupsSortByEnum string
Set of constants representing the allowable values for ListDynamicGroupsSortByEnum
const (
ListDynamicGroupsSortByTimecreated ListDynamicGroupsSortByEnum = "TIMECREATED"
ListDynamicGroupsSortByName ListDynamicGroupsSortByEnum = "NAME"
)
func GetListDynamicGroupsSortByEnumValues() []ListDynamicGroupsSortByEnum
GetListDynamicGroupsSortByEnumValues Enumerates the set of values for ListDynamicGroupsSortByEnum
func GetMappingListDynamicGroupsSortByEnum(val string) (ListDynamicGroupsSortByEnum, bool)
GetMappingListDynamicGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDynamicGroupsSortOrderEnum Enum with underlying type: string
type ListDynamicGroupsSortOrderEnum string
Set of constants representing the allowable values for ListDynamicGroupsSortOrderEnum
const (
ListDynamicGroupsSortOrderAsc ListDynamicGroupsSortOrderEnum = "ASC"
ListDynamicGroupsSortOrderDesc ListDynamicGroupsSortOrderEnum = "DESC"
)
func GetListDynamicGroupsSortOrderEnumValues() []ListDynamicGroupsSortOrderEnum
GetListDynamicGroupsSortOrderEnumValues Enumerates the set of values for ListDynamicGroupsSortOrderEnum
func GetMappingListDynamicGroupsSortOrderEnum(val string) (ListDynamicGroupsSortOrderEnum, bool)
GetMappingListDynamicGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFaultDomainsRequest wrapper for the ListFaultDomains operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListFaultDomains.go.html to see an example of how to use 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
}
func (request ListFaultDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFaultDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFaultDomainsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFaultDomainsRequest) String() string
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
ListFaultDomainsResponse wrapper for the ListFaultDomains operation
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"`
}
func (response ListFaultDomainsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFaultDomainsResponse) String() string
ListGroupsRequest wrapper for the ListGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListGroups.go.html to see an example of how to use 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
}
func (request ListGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGroupsRequest) String() string
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
ListGroupsResponse wrapper for the ListGroups operation
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"`
}
func (response ListGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGroupsResponse) String() string
ListGroupsSortByEnum Enum with underlying type: string
type ListGroupsSortByEnum string
Set of constants representing the allowable values for ListGroupsSortByEnum
const (
ListGroupsSortByTimecreated ListGroupsSortByEnum = "TIMECREATED"
ListGroupsSortByName ListGroupsSortByEnum = "NAME"
)
func GetListGroupsSortByEnumValues() []ListGroupsSortByEnum
GetListGroupsSortByEnumValues Enumerates the set of values for ListGroupsSortByEnum
func GetMappingListGroupsSortByEnum(val string) (ListGroupsSortByEnum, bool)
GetMappingListGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListGroupsSortOrderEnum Enum with underlying type: string
type ListGroupsSortOrderEnum string
Set of constants representing the allowable values for ListGroupsSortOrderEnum
const (
ListGroupsSortOrderAsc ListGroupsSortOrderEnum = "ASC"
ListGroupsSortOrderDesc ListGroupsSortOrderEnum = "DESC"
)
func GetListGroupsSortOrderEnumValues() []ListGroupsSortOrderEnum
GetListGroupsSortOrderEnumValues Enumerates the set of values for ListGroupsSortOrderEnum
func GetMappingListGroupsSortOrderEnum(val string) (ListGroupsSortOrderEnum, bool)
GetMappingListGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIamWorkRequestErrorsRequest wrapper for the ListIamWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequestErrors.go.html to see an example of how to use 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
}
func (request ListIamWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIamWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIamWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIamWorkRequestErrorsRequest) String() string
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
ListIamWorkRequestErrorsResponse wrapper for the ListIamWorkRequestErrors operation
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.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"`
}
func (response ListIamWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIamWorkRequestErrorsResponse) String() string
ListIamWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListIamWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListIamWorkRequestErrorsSortOrderEnum
const (
ListIamWorkRequestErrorsSortOrderAsc ListIamWorkRequestErrorsSortOrderEnum = "ASC"
ListIamWorkRequestErrorsSortOrderDesc ListIamWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListIamWorkRequestErrorsSortOrderEnumValues() []ListIamWorkRequestErrorsSortOrderEnum
GetListIamWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListIamWorkRequestErrorsSortOrderEnum
func GetMappingListIamWorkRequestErrorsSortOrderEnum(val string) (ListIamWorkRequestErrorsSortOrderEnum, bool)
GetMappingListIamWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIamWorkRequestLogsRequest wrapper for the ListIamWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequestLogs.go.html to see an example of how to use 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
}
func (request ListIamWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIamWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIamWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIamWorkRequestLogsRequest) String() string
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
ListIamWorkRequestLogsResponse wrapper for the ListIamWorkRequestLogs operation
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"`
}
func (response ListIamWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIamWorkRequestLogsResponse) String() string
ListIamWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListIamWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListIamWorkRequestLogsSortOrderEnum
const (
ListIamWorkRequestLogsSortOrderAsc ListIamWorkRequestLogsSortOrderEnum = "ASC"
ListIamWorkRequestLogsSortOrderDesc ListIamWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListIamWorkRequestLogsSortOrderEnumValues() []ListIamWorkRequestLogsSortOrderEnum
GetListIamWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListIamWorkRequestLogsSortOrderEnum
func GetMappingListIamWorkRequestLogsSortOrderEnum(val string) (ListIamWorkRequestLogsSortOrderEnum, bool)
GetMappingListIamWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIamWorkRequestsRequest wrapper for the ListIamWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIamWorkRequests.go.html to see an example of how to use 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
}
func (request ListIamWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIamWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIamWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIamWorkRequestsRequest) String() string
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
ListIamWorkRequestsResponse wrapper for the ListIamWorkRequests operation
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"`
}
func (response ListIamWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIamWorkRequestsResponse) String() string
ListIdentityProviderGroupsRequest wrapper for the ListIdentityProviderGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdentityProviderGroups.go.html to see an example of how to use 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
}
func (request ListIdentityProviderGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIdentityProviderGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIdentityProviderGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIdentityProviderGroupsRequest) String() string
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
ListIdentityProviderGroupsResponse wrapper for the ListIdentityProviderGroups operation
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"`
}
func (response ListIdentityProviderGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIdentityProviderGroupsResponse) String() string
ListIdentityProvidersProtocolEnum Enum with underlying type: string
type ListIdentityProvidersProtocolEnum string
Set of constants representing the allowable values for ListIdentityProvidersProtocolEnum
const (
ListIdentityProvidersProtocolSaml2 ListIdentityProvidersProtocolEnum = "SAML2"
)
func GetListIdentityProvidersProtocolEnumValues() []ListIdentityProvidersProtocolEnum
GetListIdentityProvidersProtocolEnumValues Enumerates the set of values for ListIdentityProvidersProtocolEnum
func GetMappingListIdentityProvidersProtocolEnum(val string) (ListIdentityProvidersProtocolEnum, bool)
GetMappingListIdentityProvidersProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
ListIdentityProvidersRequest wrapper for the ListIdentityProviders operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdentityProviders.go.html to see an example of how to use 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
}
func (request ListIdentityProvidersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIdentityProvidersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIdentityProvidersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIdentityProvidersRequest) String() string
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
ListIdentityProvidersResponse wrapper for the ListIdentityProviders operation
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"`
}
func (response ListIdentityProvidersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIdentityProvidersResponse) String() string
ListIdentityProvidersSortByEnum Enum with underlying type: string
type ListIdentityProvidersSortByEnum string
Set of constants representing the allowable values for ListIdentityProvidersSortByEnum
const (
ListIdentityProvidersSortByTimecreated ListIdentityProvidersSortByEnum = "TIMECREATED"
ListIdentityProvidersSortByName ListIdentityProvidersSortByEnum = "NAME"
)
func GetListIdentityProvidersSortByEnumValues() []ListIdentityProvidersSortByEnum
GetListIdentityProvidersSortByEnumValues Enumerates the set of values for ListIdentityProvidersSortByEnum
func GetMappingListIdentityProvidersSortByEnum(val string) (ListIdentityProvidersSortByEnum, bool)
GetMappingListIdentityProvidersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListIdentityProvidersSortOrderEnum Enum with underlying type: string
type ListIdentityProvidersSortOrderEnum string
Set of constants representing the allowable values for ListIdentityProvidersSortOrderEnum
const (
ListIdentityProvidersSortOrderAsc ListIdentityProvidersSortOrderEnum = "ASC"
ListIdentityProvidersSortOrderDesc ListIdentityProvidersSortOrderEnum = "DESC"
)
func GetListIdentityProvidersSortOrderEnumValues() []ListIdentityProvidersSortOrderEnum
GetListIdentityProvidersSortOrderEnumValues Enumerates the set of values for ListIdentityProvidersSortOrderEnum
func GetMappingListIdentityProvidersSortOrderEnum(val string) (ListIdentityProvidersSortOrderEnum, bool)
GetMappingListIdentityProvidersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIdpGroupMappingsRequest wrapper for the ListIdpGroupMappings operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListIdpGroupMappings.go.html to see an example of how to use 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
}
func (request ListIdpGroupMappingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIdpGroupMappingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIdpGroupMappingsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIdpGroupMappingsRequest) String() string
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
ListIdpGroupMappingsResponse wrapper for the ListIdpGroupMappings operation
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"`
}
func (response ListIdpGroupMappingsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIdpGroupMappingsResponse) String() string
ListMfaTotpDevicesRequest wrapper for the ListMfaTotpDevices operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListMfaTotpDevices.go.html to see an example of how to use 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
}
func (request ListMfaTotpDevicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListMfaTotpDevicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListMfaTotpDevicesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListMfaTotpDevicesRequest) String() string
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
ListMfaTotpDevicesResponse wrapper for the ListMfaTotpDevices operation
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"`
}
func (response ListMfaTotpDevicesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListMfaTotpDevicesResponse) String() string
ListMfaTotpDevicesSortByEnum Enum with underlying type: string
type ListMfaTotpDevicesSortByEnum string
Set of constants representing the allowable values for ListMfaTotpDevicesSortByEnum
const (
ListMfaTotpDevicesSortByTimecreated ListMfaTotpDevicesSortByEnum = "TIMECREATED"
ListMfaTotpDevicesSortByName ListMfaTotpDevicesSortByEnum = "NAME"
)
func GetListMfaTotpDevicesSortByEnumValues() []ListMfaTotpDevicesSortByEnum
GetListMfaTotpDevicesSortByEnumValues Enumerates the set of values for ListMfaTotpDevicesSortByEnum
func GetMappingListMfaTotpDevicesSortByEnum(val string) (ListMfaTotpDevicesSortByEnum, bool)
GetMappingListMfaTotpDevicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListMfaTotpDevicesSortOrderEnum Enum with underlying type: string
type ListMfaTotpDevicesSortOrderEnum string
Set of constants representing the allowable values for ListMfaTotpDevicesSortOrderEnum
const (
ListMfaTotpDevicesSortOrderAsc ListMfaTotpDevicesSortOrderEnum = "ASC"
ListMfaTotpDevicesSortOrderDesc ListMfaTotpDevicesSortOrderEnum = "DESC"
)
func GetListMfaTotpDevicesSortOrderEnumValues() []ListMfaTotpDevicesSortOrderEnum
GetListMfaTotpDevicesSortOrderEnumValues Enumerates the set of values for ListMfaTotpDevicesSortOrderEnum
func GetMappingListMfaTotpDevicesSortOrderEnum(val string) (ListMfaTotpDevicesSortOrderEnum, bool)
GetMappingListMfaTotpDevicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkSourcesRequest wrapper for the ListNetworkSources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListNetworkSources.go.html to see an example of how to use 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
}
func (request ListNetworkSourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListNetworkSourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListNetworkSourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListNetworkSourcesRequest) String() string
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
ListNetworkSourcesResponse wrapper for the ListNetworkSources operation
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"`
}
func (response ListNetworkSourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListNetworkSourcesResponse) String() string
ListNetworkSourcesSortByEnum Enum with underlying type: string
type ListNetworkSourcesSortByEnum string
Set of constants representing the allowable values for ListNetworkSourcesSortByEnum
const (
ListNetworkSourcesSortByTimecreated ListNetworkSourcesSortByEnum = "TIMECREATED"
ListNetworkSourcesSortByName ListNetworkSourcesSortByEnum = "NAME"
)
func GetListNetworkSourcesSortByEnumValues() []ListNetworkSourcesSortByEnum
GetListNetworkSourcesSortByEnumValues Enumerates the set of values for ListNetworkSourcesSortByEnum
func GetMappingListNetworkSourcesSortByEnum(val string) (ListNetworkSourcesSortByEnum, bool)
GetMappingListNetworkSourcesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListNetworkSourcesSortOrderEnum Enum with underlying type: string
type ListNetworkSourcesSortOrderEnum string
Set of constants representing the allowable values for ListNetworkSourcesSortOrderEnum
const (
ListNetworkSourcesSortOrderAsc ListNetworkSourcesSortOrderEnum = "ASC"
ListNetworkSourcesSortOrderDesc ListNetworkSourcesSortOrderEnum = "DESC"
)
func GetListNetworkSourcesSortOrderEnumValues() []ListNetworkSourcesSortOrderEnum
GetListNetworkSourcesSortOrderEnumValues Enumerates the set of values for ListNetworkSourcesSortOrderEnum
func GetMappingListNetworkSourcesSortOrderEnum(val string) (ListNetworkSourcesSortOrderEnum, bool)
GetMappingListNetworkSourcesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOAuthClientCredentialsRequest wrapper for the ListOAuthClientCredentials operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListOAuthClientCredentials.go.html to see an example of how to use 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
}
func (request ListOAuthClientCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOAuthClientCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOAuthClientCredentialsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOAuthClientCredentialsRequest) String() string
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
ListOAuthClientCredentialsResponse wrapper for the ListOAuthClientCredentials operation
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"`
}
func (response ListOAuthClientCredentialsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOAuthClientCredentialsResponse) String() string
ListPoliciesRequest wrapper for the ListPolicies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListPolicies.go.html to see an example of how to use 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
}
func (request ListPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPoliciesRequest) String() string
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
ListPoliciesResponse wrapper for the ListPolicies operation
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"`
}
func (response ListPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPoliciesResponse) String() string
ListPoliciesSortByEnum Enum with underlying type: string
type ListPoliciesSortByEnum string
Set of constants representing the allowable values for ListPoliciesSortByEnum
const (
ListPoliciesSortByTimecreated ListPoliciesSortByEnum = "TIMECREATED"
ListPoliciesSortByName ListPoliciesSortByEnum = "NAME"
)
func GetListPoliciesSortByEnumValues() []ListPoliciesSortByEnum
GetListPoliciesSortByEnumValues Enumerates the set of values for ListPoliciesSortByEnum
func GetMappingListPoliciesSortByEnum(val string) (ListPoliciesSortByEnum, bool)
GetMappingListPoliciesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPoliciesSortOrderEnum Enum with underlying type: string
type ListPoliciesSortOrderEnum string
Set of constants representing the allowable values for ListPoliciesSortOrderEnum
const (
ListPoliciesSortOrderAsc ListPoliciesSortOrderEnum = "ASC"
ListPoliciesSortOrderDesc ListPoliciesSortOrderEnum = "DESC"
)
func GetListPoliciesSortOrderEnumValues() []ListPoliciesSortOrderEnum
GetListPoliciesSortOrderEnumValues Enumerates the set of values for ListPoliciesSortOrderEnum
func GetMappingListPoliciesSortOrderEnum(val string) (ListPoliciesSortOrderEnum, bool)
GetMappingListPoliciesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRegionSubscriptionsRequest wrapper for the ListRegionSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListRegionSubscriptions.go.html to see an example of how to use 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
}
func (request ListRegionSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRegionSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRegionSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRegionSubscriptionsRequest) String() string
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
ListRegionSubscriptionsResponse wrapper for the ListRegionSubscriptions operation
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"`
}
func (response ListRegionSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRegionSubscriptionsResponse) String() string
ListRegionsRequest wrapper for the ListRegions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListRegions.go.html to see an example of how to use 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
}
func (request ListRegionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRegionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRegionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRegionsRequest) String() string
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
ListRegionsResponse wrapper for the ListRegions operation
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"`
}
func (response ListRegionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRegionsResponse) String() string
ListSmtpCredentialsRequest wrapper for the ListSmtpCredentials operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListSmtpCredentials.go.html to see an example of how to use 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
}
func (request ListSmtpCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSmtpCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSmtpCredentialsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSmtpCredentialsRequest) String() string
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
ListSmtpCredentialsResponse wrapper for the ListSmtpCredentials operation
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"`
}
func (response ListSmtpCredentialsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSmtpCredentialsResponse) String() string
ListStandardTagNamespacesRequest wrapper for the ListStandardTagNamespaces operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListStandardTagNamespaces.go.html to see an example of how to use 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
}
func (request ListStandardTagNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListStandardTagNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListStandardTagNamespacesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListStandardTagNamespacesRequest) String() string
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
ListStandardTagNamespacesResponse wrapper for the ListStandardTagNamespaces operation
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"`
}
func (response ListStandardTagNamespacesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListStandardTagNamespacesResponse) String() string
ListSwiftPasswordsRequest wrapper for the ListSwiftPasswords operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListSwiftPasswords.go.html to see an example of how to use 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
}
func (request ListSwiftPasswordsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSwiftPasswordsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSwiftPasswordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSwiftPasswordsRequest) String() string
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
ListSwiftPasswordsResponse wrapper for the ListSwiftPasswords operation
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"`
}
func (response ListSwiftPasswordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSwiftPasswordsResponse) String() string
ListTagDefaultsRequest wrapper for the ListTagDefaults operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTagDefaults.go.html to see an example of how to use 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
}
func (request ListTagDefaultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTagDefaultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTagDefaultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTagDefaultsRequest) String() string
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
ListTagDefaultsResponse wrapper for the ListTagDefaults operation
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"`
}
func (response ListTagDefaultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTagDefaultsResponse) String() string
ListTagNamespacesRequest wrapper for the ListTagNamespaces operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTagNamespaces.go.html to see an example of how to use 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
}
func (request ListTagNamespacesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTagNamespacesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTagNamespacesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTagNamespacesRequest) String() string
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
ListTagNamespacesResponse wrapper for the ListTagNamespaces operation
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"`
}
func (response ListTagNamespacesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTagNamespacesResponse) String() string
ListTaggingWorkRequestErrorsRequest wrapper for the ListTaggingWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequestErrors.go.html to see an example of how to use 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
}
func (request ListTaggingWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTaggingWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTaggingWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTaggingWorkRequestErrorsRequest) String() string
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
ListTaggingWorkRequestErrorsResponse wrapper for the ListTaggingWorkRequestErrors operation
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"`
}
func (response ListTaggingWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTaggingWorkRequestErrorsResponse) String() string
ListTaggingWorkRequestLogsRequest wrapper for the ListTaggingWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequestLogs.go.html to see an example of how to use 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
}
func (request ListTaggingWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTaggingWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTaggingWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTaggingWorkRequestLogsRequest) String() string
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
ListTaggingWorkRequestLogsResponse wrapper for the ListTaggingWorkRequestLogs operation
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"`
}
func (response ListTaggingWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTaggingWorkRequestLogsResponse) String() string
ListTaggingWorkRequestsRequest wrapper for the ListTaggingWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTaggingWorkRequests.go.html to see an example of how to use 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
}
func (request ListTaggingWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTaggingWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTaggingWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTaggingWorkRequestsRequest) String() string
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
ListTaggingWorkRequestsResponse wrapper for the ListTaggingWorkRequests operation
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"`
}
func (response ListTaggingWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTaggingWorkRequestsResponse) String() string
ListTagsRequest wrapper for the ListTags operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListTags.go.html to see an example of how to use 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
}
func (request ListTagsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTagsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTagsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTagsRequest) String() string
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
ListTagsResponse wrapper for the ListTags operation
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"`
}
func (response ListTagsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTagsResponse) String() string
ListUserGroupMembershipsRequest wrapper for the ListUserGroupMemberships operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListUserGroupMemberships.go.html to see an example of how to use 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
}
func (request ListUserGroupMembershipsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListUserGroupMembershipsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListUserGroupMembershipsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListUserGroupMembershipsRequest) String() string
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
ListUserGroupMembershipsResponse wrapper for the ListUserGroupMemberships operation
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"`
}
func (response ListUserGroupMembershipsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListUserGroupMembershipsResponse) String() string
ListUsersRequest wrapper for the ListUsers operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListUsers.go.html to see an example of how to use 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
}
func (request ListUsersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListUsersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListUsersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListUsersRequest) String() string
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
ListUsersResponse wrapper for the ListUsers operation
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"`
}
func (response ListUsersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListUsersResponse) String() string
ListUsersSortByEnum Enum with underlying type: string
type ListUsersSortByEnum string
Set of constants representing the allowable values for ListUsersSortByEnum
const (
ListUsersSortByTimecreated ListUsersSortByEnum = "TIMECREATED"
ListUsersSortByName ListUsersSortByEnum = "NAME"
)
func GetListUsersSortByEnumValues() []ListUsersSortByEnum
GetListUsersSortByEnumValues Enumerates the set of values for ListUsersSortByEnum
func GetMappingListUsersSortByEnum(val string) (ListUsersSortByEnum, bool)
GetMappingListUsersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsersSortOrderEnum Enum with underlying type: string
type ListUsersSortOrderEnum string
Set of constants representing the allowable values for ListUsersSortOrderEnum
const (
ListUsersSortOrderAsc ListUsersSortOrderEnum = "ASC"
ListUsersSortOrderDesc ListUsersSortOrderEnum = "DESC"
)
func GetListUsersSortOrderEnumValues() []ListUsersSortOrderEnum
GetListUsersSortOrderEnumValues Enumerates the set of values for ListUsersSortOrderEnum
func GetMappingListUsersSortOrderEnum(val string) (ListUsersSortOrderEnum, bool)
GetMappingListUsersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ListWorkRequests.go.html to see an example of how to use 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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
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.oracle.com/iaas/Content/Identity/mfa/understand-multi-factor-authentication.htm).
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"`
}
func (m MfaTotpDevice) String() string
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
MfaTotpDeviceLifecycleStateEnum Enum with underlying type: string
type MfaTotpDeviceLifecycleStateEnum string
Set of constants representing the allowable values for MfaTotpDeviceLifecycleStateEnum
const (
MfaTotpDeviceLifecycleStateCreating MfaTotpDeviceLifecycleStateEnum = "CREATING"
MfaTotpDeviceLifecycleStateActive MfaTotpDeviceLifecycleStateEnum = "ACTIVE"
MfaTotpDeviceLifecycleStateInactive MfaTotpDeviceLifecycleStateEnum = "INACTIVE"
MfaTotpDeviceLifecycleStateDeleting MfaTotpDeviceLifecycleStateEnum = "DELETING"
MfaTotpDeviceLifecycleStateDeleted MfaTotpDeviceLifecycleStateEnum = "DELETED"
)
func GetMappingMfaTotpDeviceLifecycleStateEnum(val string) (MfaTotpDeviceLifecycleStateEnum, bool)
GetMappingMfaTotpDeviceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMfaTotpDeviceLifecycleStateEnumValues() []MfaTotpDeviceLifecycleStateEnum
GetMfaTotpDeviceLifecycleStateEnumValues Enumerates the set of values for MfaTotpDeviceLifecycleStateEnum
MfaTotpDeviceSummary As the name suggests, a `MfaTotpDeviceSummary` object contains information about a `MfaTotpDevice`.
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"`
}
func (m MfaTotpDeviceSummary) String() string
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
MfaTotpDeviceSummaryLifecycleStateEnum Enum with underlying type: string
type MfaTotpDeviceSummaryLifecycleStateEnum string
Set of constants representing the allowable values for MfaTotpDeviceSummaryLifecycleStateEnum
const (
MfaTotpDeviceSummaryLifecycleStateCreating MfaTotpDeviceSummaryLifecycleStateEnum = "CREATING"
MfaTotpDeviceSummaryLifecycleStateActive MfaTotpDeviceSummaryLifecycleStateEnum = "ACTIVE"
MfaTotpDeviceSummaryLifecycleStateInactive MfaTotpDeviceSummaryLifecycleStateEnum = "INACTIVE"
MfaTotpDeviceSummaryLifecycleStateDeleting MfaTotpDeviceSummaryLifecycleStateEnum = "DELETING"
MfaTotpDeviceSummaryLifecycleStateDeleted MfaTotpDeviceSummaryLifecycleStateEnum = "DELETED"
)
func GetMappingMfaTotpDeviceSummaryLifecycleStateEnum(val string) (MfaTotpDeviceSummaryLifecycleStateEnum, bool)
GetMappingMfaTotpDeviceSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMfaTotpDeviceSummaryLifecycleStateEnumValues() []MfaTotpDeviceSummaryLifecycleStateEnum
GetMfaTotpDeviceSummaryLifecycleStateEnumValues Enumerates the set of values for MfaTotpDeviceSummaryLifecycleStateEnum
MfaTotpToken Totp token for MFA
type MfaTotpToken struct {
// The Totp token for MFA.
TotpToken *string `mandatory:"false" json:"totpToken"`
}
func (m MfaTotpToken) String() string
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
MoveCompartmentDetails The representation of MoveCompartmentDetails
type MoveCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment
// into which to move the compartment.
TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`
}
func (m MoveCompartmentDetails) String() string
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
MoveCompartmentRequest wrapper for the MoveCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/MoveCompartment.go.html to see an example of how to use 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
}
func (request MoveCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request MoveCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request MoveCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request MoveCompartmentRequest) String() string
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
MoveCompartmentResponse wrapper for the MoveCompartment operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response MoveCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response MoveCompartmentResponse) String() string
NetworkPolicy Network policy, which consists of a list of network source IDs.
type NetworkPolicy struct {
// Network Source ids
NetworkSourceIds []string `mandatory:"false" json:"networkSourceIds"`
}
func (m NetworkPolicy) String() string
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
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.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m NetworkSources) String() string
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
NetworkSourcesLifecycleStateEnum Enum with underlying type: string
type NetworkSourcesLifecycleStateEnum string
Set of constants representing the allowable values for NetworkSourcesLifecycleStateEnum
const (
NetworkSourcesLifecycleStateCreating NetworkSourcesLifecycleStateEnum = "CREATING"
NetworkSourcesLifecycleStateActive NetworkSourcesLifecycleStateEnum = "ACTIVE"
NetworkSourcesLifecycleStateInactive NetworkSourcesLifecycleStateEnum = "INACTIVE"
NetworkSourcesLifecycleStateDeleting NetworkSourcesLifecycleStateEnum = "DELETING"
NetworkSourcesLifecycleStateDeleted NetworkSourcesLifecycleStateEnum = "DELETED"
)
func GetMappingNetworkSourcesLifecycleStateEnum(val string) (NetworkSourcesLifecycleStateEnum, bool)
GetMappingNetworkSourcesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkSourcesLifecycleStateEnumValues() []NetworkSourcesLifecycleStateEnum
GetNetworkSourcesLifecycleStateEnumValues Enumerates the set of values for NetworkSourcesLifecycleStateEnum
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.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m NetworkSourcesSummary) String() string
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
NetworkSourcesVirtualSourceList The representation of NetworkSourcesVirtualSourceList
type NetworkSourcesVirtualSourceList struct {
VcnId *string `mandatory:"false" json:"vcnId"`
IpRanges []string `mandatory:"false" json:"ipRanges"`
}
func (m NetworkSourcesVirtualSourceList) String() string
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
OAuth2ClientCredential User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.
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"`
}
func (m OAuth2ClientCredential) String() string
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
OAuth2ClientCredentialLifecycleStateEnum Enum with underlying type: string
type OAuth2ClientCredentialLifecycleStateEnum string
Set of constants representing the allowable values for OAuth2ClientCredentialLifecycleStateEnum
const (
OAuth2ClientCredentialLifecycleStateCreating OAuth2ClientCredentialLifecycleStateEnum = "CREATING"
OAuth2ClientCredentialLifecycleStateActive OAuth2ClientCredentialLifecycleStateEnum = "ACTIVE"
OAuth2ClientCredentialLifecycleStateInactive OAuth2ClientCredentialLifecycleStateEnum = "INACTIVE"
OAuth2ClientCredentialLifecycleStateDeleting OAuth2ClientCredentialLifecycleStateEnum = "DELETING"
OAuth2ClientCredentialLifecycleStateDeleted OAuth2ClientCredentialLifecycleStateEnum = "DELETED"
)
func GetMappingOAuth2ClientCredentialLifecycleStateEnum(val string) (OAuth2ClientCredentialLifecycleStateEnum, bool)
GetMappingOAuth2ClientCredentialLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOAuth2ClientCredentialLifecycleStateEnumValues() []OAuth2ClientCredentialLifecycleStateEnum
GetOAuth2ClientCredentialLifecycleStateEnumValues Enumerates the set of values for OAuth2ClientCredentialLifecycleStateEnum
OAuth2ClientCredentialSummary User can define Oauth clients in IAM, then use it to generate a token to grant access to app resources.
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"`
}
func (m OAuth2ClientCredentialSummary) String() string
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
OAuth2ClientCredentialSummaryLifecycleStateEnum Enum with underlying type: string
type OAuth2ClientCredentialSummaryLifecycleStateEnum string
Set of constants representing the allowable values for OAuth2ClientCredentialSummaryLifecycleStateEnum
const (
OAuth2ClientCredentialSummaryLifecycleStateCreating OAuth2ClientCredentialSummaryLifecycleStateEnum = "CREATING"
OAuth2ClientCredentialSummaryLifecycleStateActive OAuth2ClientCredentialSummaryLifecycleStateEnum = "ACTIVE"
OAuth2ClientCredentialSummaryLifecycleStateInactive OAuth2ClientCredentialSummaryLifecycleStateEnum = "INACTIVE"
OAuth2ClientCredentialSummaryLifecycleStateDeleting OAuth2ClientCredentialSummaryLifecycleStateEnum = "DELETING"
OAuth2ClientCredentialSummaryLifecycleStateDeleted OAuth2ClientCredentialSummaryLifecycleStateEnum = "DELETED"
)
func GetMappingOAuth2ClientCredentialSummaryLifecycleStateEnum(val string) (OAuth2ClientCredentialSummaryLifecycleStateEnum, bool)
GetMappingOAuth2ClientCredentialSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOAuth2ClientCredentialSummaryLifecycleStateEnumValues() []OAuth2ClientCredentialSummaryLifecycleStateEnum
GetOAuth2ClientCredentialSummaryLifecycleStateEnumValues Enumerates the set of values for OAuth2ClientCredentialSummaryLifecycleStateEnum
PasswordPolicy Password policy, currently set for the given compartment.
type PasswordPolicy struct {
// Minimum password length required.
MinimumPasswordLength *int `mandatory:"false" json:"minimumPasswordLength"`
// At least one uppercase character required.
IsUppercaseCharactersRequired *bool `mandatory:"false" json:"isUppercaseCharactersRequired"`
// At least one lower case character required.
IsLowercaseCharactersRequired *bool `mandatory:"false" json:"isLowercaseCharactersRequired"`
// At least one numeric character required.
IsNumericCharactersRequired *bool `mandatory:"false" json:"isNumericCharactersRequired"`
// At least one special character required.
IsSpecialCharactersRequired *bool `mandatory:"false" json:"isSpecialCharactersRequired"`
// User name is allowed to be part of the password.
IsUsernameContainmentAllowed *bool `mandatory:"false" json:"isUsernameContainmentAllowed"`
}
func (m PasswordPolicy) String() string
func (m PasswordPolicy) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.oracle.com/iaas/Content/Identity/getstarted/identity-domains.htm). If you're new to policies, see Get Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). The word "policy" is used by people in different ways:
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.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Policy) String() string
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
PolicyLifecycleStateEnum Enum with underlying type: string
type PolicyLifecycleStateEnum string
Set of constants representing the allowable values for PolicyLifecycleStateEnum
const (
PolicyLifecycleStateCreating PolicyLifecycleStateEnum = "CREATING"
PolicyLifecycleStateActive PolicyLifecycleStateEnum = "ACTIVE"
PolicyLifecycleStateInactive PolicyLifecycleStateEnum = "INACTIVE"
PolicyLifecycleStateDeleting PolicyLifecycleStateEnum = "DELETING"
PolicyLifecycleStateDeleted PolicyLifecycleStateEnum = "DELETED"
)
func GetMappingPolicyLifecycleStateEnum(val string) (PolicyLifecycleStateEnum, bool)
GetMappingPolicyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPolicyLifecycleStateEnumValues() []PolicyLifecycleStateEnum
GetPolicyLifecycleStateEnumValues Enumerates the set of values for PolicyLifecycleStateEnum
RecoverCompartmentRequest wrapper for the RecoverCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RecoverCompartment.go.html to see an example of how to use 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
}
func (request RecoverCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RecoverCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RecoverCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RecoverCompartmentRequest) String() string
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
RecoverCompartmentResponse wrapper for the RecoverCompartment operation
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"`
}
func (response RecoverCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RecoverCompartmentResponse) String() string
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.oracle.com/iaas/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.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type Region struct {
// The key of the region. See Regions and Availability Domains (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/regions.htm)
// for the full list of supported region names.
// Example: `us-phoenix-1`
Name *string `mandatory:"false" json:"name"`
}
func (m Region) String() string
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
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.oracle.com/iaas/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.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type RegionSubscription struct {
// The region's key. See Regions and Availability Domains (https://docs.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m RegionSubscription) String() string
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
RegionSubscriptionStatusEnum Enum with underlying type: string
type RegionSubscriptionStatusEnum string
Set of constants representing the allowable values for RegionSubscriptionStatusEnum
const (
RegionSubscriptionStatusReady RegionSubscriptionStatusEnum = "READY"
RegionSubscriptionStatusInProgress RegionSubscriptionStatusEnum = "IN_PROGRESS"
)
func GetMappingRegionSubscriptionStatusEnum(val string) (RegionSubscriptionStatusEnum, bool)
GetMappingRegionSubscriptionStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRegionSubscriptionStatusEnumValues() []RegionSubscriptionStatusEnum
GetRegionSubscriptionStatusEnumValues Enumerates the set of values for RegionSubscriptionStatusEnum
RemoveLockDetails Request payload to remove lock to the resource.
type RemoveLockDetails struct {
// Type of the lock.
Type RemoveLockDetailsTypeEnum `mandatory:"true" json:"type"`
}
func (m RemoveLockDetails) String() string
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
RemoveLockDetailsTypeEnum Enum with underlying type: string
type RemoveLockDetailsTypeEnum string
Set of constants representing the allowable values for RemoveLockDetailsTypeEnum
const (
RemoveLockDetailsTypeFull RemoveLockDetailsTypeEnum = "FULL"
RemoveLockDetailsTypeDelete RemoveLockDetailsTypeEnum = "DELETE"
)
func GetMappingRemoveLockDetailsTypeEnum(val string) (RemoveLockDetailsTypeEnum, bool)
GetMappingRemoveLockDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemoveLockDetailsTypeEnumValues() []RemoveLockDetailsTypeEnum
GetRemoveLockDetailsTypeEnumValues Enumerates the set of values for RemoveLockDetailsTypeEnum
RemoveTagDefaultLockRequest wrapper for the RemoveTagDefaultLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveTagDefaultLock.go.html to see an example of how to use RemoveTagDefaultLockRequest.
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
}
func (request RemoveTagDefaultLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveTagDefaultLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveTagDefaultLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveTagDefaultLockRequest) String() string
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
RemoveTagDefaultLockResponse wrapper for the RemoveTagDefaultLock operation
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"`
}
func (response RemoveTagDefaultLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveTagDefaultLockResponse) String() string
RemoveTagNamespaceLockRequest wrapper for the RemoveTagNamespaceLock operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveTagNamespaceLock.go.html to see an example of how to use RemoveTagNamespaceLockRequest.
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
}
func (request RemoveTagNamespaceLockRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveTagNamespaceLockRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveTagNamespaceLockRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveTagNamespaceLockRequest) String() string
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
RemoveTagNamespaceLockResponse wrapper for the RemoveTagNamespaceLock operation
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"`
}
func (response RemoveTagNamespaceLockResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveTagNamespaceLockResponse) String() string
RemoveUserFromGroupRequest wrapper for the RemoveUserFromGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/RemoveUserFromGroup.go.html to see an example of how to use 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
}
func (request RemoveUserFromGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveUserFromGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveUserFromGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveUserFromGroupRequest) String() string
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
RemoveUserFromGroupResponse wrapper for the RemoveUserFromGroup operation
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"`
}
func (response RemoveUserFromGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveUserFromGroupResponse) String() string
ReplicatedRegionDetails (For tenancies that support identity domains) Properties for a region where a replica for the identity domain exists.
type ReplicatedRegionDetails struct {
// A REPLICATION_ENABLED region, e.g. us-ashburn-1.
// See Regions and Availability Domains (https://docs.oracle.com/iaas/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"`
}
func (m ReplicatedRegionDetails) String() string
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
ReplicatedRegionDetailsStateEnum Enum with underlying type: string
type ReplicatedRegionDetailsStateEnum string
Set of constants representing the allowable values for ReplicatedRegionDetailsStateEnum
const (
ReplicatedRegionDetailsStateEnablingReplication ReplicatedRegionDetailsStateEnum = "ENABLING_REPLICATION"
ReplicatedRegionDetailsStateReplicationEnabled ReplicatedRegionDetailsStateEnum = "REPLICATION_ENABLED"
ReplicatedRegionDetailsStateDisablingReplication ReplicatedRegionDetailsStateEnum = "DISABLING_REPLICATION"
ReplicatedRegionDetailsStateReplicationDisabled ReplicatedRegionDetailsStateEnum = "REPLICATION_DISABLED"
ReplicatedRegionDetailsStateDeleted ReplicatedRegionDetailsStateEnum = "DELETED"
)
func GetMappingReplicatedRegionDetailsStateEnum(val string) (ReplicatedRegionDetailsStateEnum, bool)
GetMappingReplicatedRegionDetailsStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicatedRegionDetailsStateEnumValues() []ReplicatedRegionDetailsStateEnum
GetReplicatedRegionDetailsStateEnumValues Enumerates the set of values for ReplicatedRegionDetailsStateEnum
ResetIdpScimClientRequest wrapper for the ResetIdpScimClient operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/ResetIdpScimClient.go.html to see an example of how to use 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
}
func (request ResetIdpScimClientRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResetIdpScimClientRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResetIdpScimClientRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResetIdpScimClientRequest) String() string
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
ResetIdpScimClientResponse wrapper for the ResetIdpScimClient operation
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"`
}
func (response ResetIdpScimClientResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResetIdpScimClientResponse) String() string
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.
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"`
}
func (m ResourceLock) String() string
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
ResourceLockTypeEnum Enum with underlying type: string
type ResourceLockTypeEnum string
Set of constants representing the allowable values for ResourceLockTypeEnum
const (
ResourceLockTypeFull ResourceLockTypeEnum = "FULL"
ResourceLockTypeDelete ResourceLockTypeEnum = "DELETE"
)
func GetMappingResourceLockTypeEnum(val string) (ResourceLockTypeEnum, bool)
GetMappingResourceLockTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceLockTypeEnumValues() []ResourceLockTypeEnum
GetResourceLockTypeEnumValues Enumerates the set of values for ResourceLockTypeEnum
Saml2IdentityProvider A special type of IdentityProvider that supports the SAML 2.0 protocol. For more information, see Identity Providers and Federation (https://docs.oracle.com/iaas/Content/Identity/Concepts/federation.htm).
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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m Saml2IdentityProvider) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m Saml2IdentityProvider) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m Saml2IdentityProvider) GetDescription() *string
GetDescription returns Description
func (m Saml2IdentityProvider) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m Saml2IdentityProvider) GetId() *string
GetId returns Id
func (m Saml2IdentityProvider) GetInactiveStatus() *int64
GetInactiveStatus returns InactiveStatus
func (m Saml2IdentityProvider) GetLifecycleState() IdentityProviderLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m Saml2IdentityProvider) GetName() *string
GetName returns Name
func (m Saml2IdentityProvider) GetProductType() *string
GetProductType returns ProductType
func (m Saml2IdentityProvider) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m Saml2IdentityProvider) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Saml2IdentityProvider) String() string
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
ScimClientCredentials The OAuth2 client credentials.
type ScimClientCredentials struct {
// The client identifier.
ClientId *string `mandatory:"false" json:"clientId"`
// The client secret.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
}
func (m ScimClientCredentials) String() string
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
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.oracle.com/iaas/Content/Identity/access/managing-user-credentials.htm#SMTP).
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"`
}
func (m SmtpCredential) String() string
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
SmtpCredentialLifecycleStateEnum Enum with underlying type: string
type SmtpCredentialLifecycleStateEnum string
Set of constants representing the allowable values for SmtpCredentialLifecycleStateEnum
const (
SmtpCredentialLifecycleStateCreating SmtpCredentialLifecycleStateEnum = "CREATING"
SmtpCredentialLifecycleStateActive SmtpCredentialLifecycleStateEnum = "ACTIVE"
SmtpCredentialLifecycleStateInactive SmtpCredentialLifecycleStateEnum = "INACTIVE"
SmtpCredentialLifecycleStateDeleting SmtpCredentialLifecycleStateEnum = "DELETING"
SmtpCredentialLifecycleStateDeleted SmtpCredentialLifecycleStateEnum = "DELETED"
)
func GetMappingSmtpCredentialLifecycleStateEnum(val string) (SmtpCredentialLifecycleStateEnum, bool)
GetMappingSmtpCredentialLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSmtpCredentialLifecycleStateEnumValues() []SmtpCredentialLifecycleStateEnum
GetSmtpCredentialLifecycleStateEnumValues Enumerates the set of values for SmtpCredentialLifecycleStateEnum
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.oracle.com/iaas/Content/Email/Concepts/overview.htm).
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"`
}
func (m SmtpCredentialSummary) String() string
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
SmtpCredentialSummaryLifecycleStateEnum Enum with underlying type: string
type SmtpCredentialSummaryLifecycleStateEnum string
Set of constants representing the allowable values for SmtpCredentialSummaryLifecycleStateEnum
const (
SmtpCredentialSummaryLifecycleStateCreating SmtpCredentialSummaryLifecycleStateEnum = "CREATING"
SmtpCredentialSummaryLifecycleStateActive SmtpCredentialSummaryLifecycleStateEnum = "ACTIVE"
SmtpCredentialSummaryLifecycleStateInactive SmtpCredentialSummaryLifecycleStateEnum = "INACTIVE"
SmtpCredentialSummaryLifecycleStateDeleting SmtpCredentialSummaryLifecycleStateEnum = "DELETING"
SmtpCredentialSummaryLifecycleStateDeleted SmtpCredentialSummaryLifecycleStateEnum = "DELETED"
)
func GetMappingSmtpCredentialSummaryLifecycleStateEnum(val string) (SmtpCredentialSummaryLifecycleStateEnum, bool)
GetMappingSmtpCredentialSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSmtpCredentialSummaryLifecycleStateEnumValues() []SmtpCredentialSummaryLifecycleStateEnum
GetSmtpCredentialSummaryLifecycleStateEnumValues Enumerates the set of values for SmtpCredentialSummaryLifecycleStateEnum
StandardTagDefinitionTemplate The template of the tag definition. This object includes necessary details to create the provided standard tag definition.
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"`
}
func (m StandardTagDefinitionTemplate) String() string
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
StandardTagDefinitionTemplateEnumMutabilityEnum Enum with underlying type: string
type StandardTagDefinitionTemplateEnumMutabilityEnum string
Set of constants representing the allowable values for StandardTagDefinitionTemplateEnumMutabilityEnum
const (
StandardTagDefinitionTemplateEnumMutabilityImmutable StandardTagDefinitionTemplateEnumMutabilityEnum = "IMMUTABLE"
StandardTagDefinitionTemplateEnumMutabilityMutable StandardTagDefinitionTemplateEnumMutabilityEnum = "MUTABLE"
StandardTagDefinitionTemplateEnumMutabilityAppendable StandardTagDefinitionTemplateEnumMutabilityEnum = "APPENDABLE"
)
func GetMappingStandardTagDefinitionTemplateEnumMutabilityEnum(val string) (StandardTagDefinitionTemplateEnumMutabilityEnum, bool)
GetMappingStandardTagDefinitionTemplateEnumMutabilityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStandardTagDefinitionTemplateEnumMutabilityEnumValues() []StandardTagDefinitionTemplateEnumMutabilityEnum
GetStandardTagDefinitionTemplateEnumMutabilityEnumValues Enumerates the set of values for StandardTagDefinitionTemplateEnumMutabilityEnum
StandardTagDefinitionTemplateTypeEnum Enum with underlying type: string
type StandardTagDefinitionTemplateTypeEnum string
Set of constants representing the allowable values for StandardTagDefinitionTemplateTypeEnum
const (
StandardTagDefinitionTemplateTypeEnumvalue StandardTagDefinitionTemplateTypeEnum = "ENUM"
StandardTagDefinitionTemplateTypeString StandardTagDefinitionTemplateTypeEnum = "STRING"
)
func GetMappingStandardTagDefinitionTemplateTypeEnum(val string) (StandardTagDefinitionTemplateTypeEnum, bool)
GetMappingStandardTagDefinitionTemplateTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStandardTagDefinitionTemplateTypeEnumValues() []StandardTagDefinitionTemplateTypeEnum
GetStandardTagDefinitionTemplateTypeEnumValues Enumerates the set of values for StandardTagDefinitionTemplateTypeEnum
StandardTagNamespaceTemplate The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace.
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"`
}
func (m StandardTagNamespaceTemplate) String() string
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
StandardTagNamespaceTemplateSummary The template of the standard tag namespace. This object includes necessary details to create the provided standard tag namespace.
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"`
}
func (m StandardTagNamespaceTemplateSummary) String() string
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
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.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).
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"`
}
func (m SwiftPassword) String() string
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
SwiftPasswordLifecycleStateEnum Enum with underlying type: string
type SwiftPasswordLifecycleStateEnum string
Set of constants representing the allowable values for SwiftPasswordLifecycleStateEnum
const (
SwiftPasswordLifecycleStateCreating SwiftPasswordLifecycleStateEnum = "CREATING"
SwiftPasswordLifecycleStateActive SwiftPasswordLifecycleStateEnum = "ACTIVE"
SwiftPasswordLifecycleStateInactive SwiftPasswordLifecycleStateEnum = "INACTIVE"
SwiftPasswordLifecycleStateDeleting SwiftPasswordLifecycleStateEnum = "DELETING"
SwiftPasswordLifecycleStateDeleted SwiftPasswordLifecycleStateEnum = "DELETED"
)
func GetMappingSwiftPasswordLifecycleStateEnum(val string) (SwiftPasswordLifecycleStateEnum, bool)
GetMappingSwiftPasswordLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSwiftPasswordLifecycleStateEnumValues() []SwiftPasswordLifecycleStateEnum
GetSwiftPasswordLifecycleStateEnumValues Enumerates the set of values for SwiftPasswordLifecycleStateEnum
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.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m Tag) String() string
func (m *Tag) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
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.oracle.com/iaas/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.
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"`
}
func (m TagDefault) String() string
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
TagDefaultLifecycleStateEnum Enum with underlying type: string
type TagDefaultLifecycleStateEnum string
Set of constants representing the allowable values for TagDefaultLifecycleStateEnum
const (
TagDefaultLifecycleStateActive TagDefaultLifecycleStateEnum = "ACTIVE"
)
func GetMappingTagDefaultLifecycleStateEnum(val string) (TagDefaultLifecycleStateEnum, bool)
GetMappingTagDefaultLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTagDefaultLifecycleStateEnumValues() []TagDefaultLifecycleStateEnum
GetTagDefaultLifecycleStateEnumValues Enumerates the set of values for TagDefaultLifecycleStateEnum
TagDefaultSummary Summary information for the specified tag default.
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"`
}
func (m TagDefaultSummary) String() string
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
TagDefaultSummaryLifecycleStateEnum Enum with underlying type: string
type TagDefaultSummaryLifecycleStateEnum string
Set of constants representing the allowable values for TagDefaultSummaryLifecycleStateEnum
const (
TagDefaultSummaryLifecycleStateActive TagDefaultSummaryLifecycleStateEnum = "ACTIVE"
)
func GetMappingTagDefaultSummaryLifecycleStateEnum(val string) (TagDefaultSummaryLifecycleStateEnum, bool)
GetMappingTagDefaultSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTagDefaultSummaryLifecycleStateEnumValues() []TagDefaultSummaryLifecycleStateEnum
GetTagDefaultSummaryLifecycleStateEnumValues Enumerates the set of values for TagDefaultSummaryLifecycleStateEnum
TagLifecycleStateEnum Enum with underlying type: string
type TagLifecycleStateEnum string
Set of constants representing the allowable values for TagLifecycleStateEnum
const (
TagLifecycleStateActive TagLifecycleStateEnum = "ACTIVE"
TagLifecycleStateInactive TagLifecycleStateEnum = "INACTIVE"
TagLifecycleStateDeleting TagLifecycleStateEnum = "DELETING"
TagLifecycleStateDeleted TagLifecycleStateEnum = "DELETED"
)
func GetMappingTagLifecycleStateEnum(val string) (TagLifecycleStateEnum, bool)
GetMappingTagLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTagLifecycleStateEnumValues() []TagLifecycleStateEnum
GetTagLifecycleStateEnumValues Enumerates the set of values for TagLifecycleStateEnum
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.oracle.com/iaas/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m TagNamespace) String() string
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
TagNamespaceLifecycleStateEnum Enum with underlying type: string
type TagNamespaceLifecycleStateEnum string
Set of constants representing the allowable values for TagNamespaceLifecycleStateEnum
const (
TagNamespaceLifecycleStateActive TagNamespaceLifecycleStateEnum = "ACTIVE"
TagNamespaceLifecycleStateInactive TagNamespaceLifecycleStateEnum = "INACTIVE"
TagNamespaceLifecycleStateDeleting TagNamespaceLifecycleStateEnum = "DELETING"
TagNamespaceLifecycleStateDeleted TagNamespaceLifecycleStateEnum = "DELETED"
)
func GetMappingTagNamespaceLifecycleStateEnum(val string) (TagNamespaceLifecycleStateEnum, bool)
GetMappingTagNamespaceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTagNamespaceLifecycleStateEnumValues() []TagNamespaceLifecycleStateEnum
GetTagNamespaceLifecycleStateEnumValues Enumerates the set of values for TagNamespaceLifecycleStateEnum
TagNamespaceSummary A container for defined tags.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m TagNamespaceSummary) String() string
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
TagSummary A tag definition that belongs to a specific tag namespace.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m TagSummary) String() string
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
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.
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"`
}
func (m TaggingWorkRequest) String() string
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
TaggingWorkRequestErrorSummary The error entity.
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"`
}
func (m TaggingWorkRequestErrorSummary) String() string
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
TaggingWorkRequestLogSummary The log entity.
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"`
}
func (m TaggingWorkRequestLogSummary) String() string
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
TaggingWorkRequestOperationTypeEnum Enum with underlying type: string
type TaggingWorkRequestOperationTypeEnum string
Set of constants representing the allowable values for TaggingWorkRequestOperationTypeEnum
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"
)
func GetMappingTaggingWorkRequestOperationTypeEnum(val string) (TaggingWorkRequestOperationTypeEnum, bool)
GetMappingTaggingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTaggingWorkRequestOperationTypeEnumValues() []TaggingWorkRequestOperationTypeEnum
GetTaggingWorkRequestOperationTypeEnumValues Enumerates the set of values for TaggingWorkRequestOperationTypeEnum
TaggingWorkRequestStatusEnum Enum with underlying type: string
type TaggingWorkRequestStatusEnum string
Set of constants representing the allowable values for TaggingWorkRequestStatusEnum
const (
TaggingWorkRequestStatusAccepted TaggingWorkRequestStatusEnum = "ACCEPTED"
TaggingWorkRequestStatusInProgress TaggingWorkRequestStatusEnum = "IN_PROGRESS"
TaggingWorkRequestStatusFailed TaggingWorkRequestStatusEnum = "FAILED"
TaggingWorkRequestStatusSucceeded TaggingWorkRequestStatusEnum = "SUCCEEDED"
TaggingWorkRequestStatusPartiallySucceeded TaggingWorkRequestStatusEnum = "PARTIALLY_SUCCEEDED"
TaggingWorkRequestStatusCanceling TaggingWorkRequestStatusEnum = "CANCELING"
TaggingWorkRequestStatusCanceled TaggingWorkRequestStatusEnum = "CANCELED"
)
func GetMappingTaggingWorkRequestStatusEnum(val string) (TaggingWorkRequestStatusEnum, bool)
GetMappingTaggingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTaggingWorkRequestStatusEnumValues() []TaggingWorkRequestStatusEnum
GetTaggingWorkRequestStatusEnumValues Enumerates the set of values for TaggingWorkRequestStatusEnum
TaggingWorkRequestSummary The work request summary. Tracks the status of the asynchronous operation.
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"`
}
func (m TaggingWorkRequestSummary) String() string
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
TaggingWorkRequestSummaryOperationTypeEnum Enum with underlying type: string
type TaggingWorkRequestSummaryOperationTypeEnum string
Set of constants representing the allowable values for TaggingWorkRequestSummaryOperationTypeEnum
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"
)
func GetMappingTaggingWorkRequestSummaryOperationTypeEnum(val string) (TaggingWorkRequestSummaryOperationTypeEnum, bool)
GetMappingTaggingWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTaggingWorkRequestSummaryOperationTypeEnumValues() []TaggingWorkRequestSummaryOperationTypeEnum
GetTaggingWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for TaggingWorkRequestSummaryOperationTypeEnum
TaggingWorkRequestSummaryStatusEnum Enum with underlying type: string
type TaggingWorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for TaggingWorkRequestSummaryStatusEnum
const (
TaggingWorkRequestSummaryStatusAccepted TaggingWorkRequestSummaryStatusEnum = "ACCEPTED"
TaggingWorkRequestSummaryStatusInProgress TaggingWorkRequestSummaryStatusEnum = "IN_PROGRESS"
TaggingWorkRequestSummaryStatusFailed TaggingWorkRequestSummaryStatusEnum = "FAILED"
TaggingWorkRequestSummaryStatusSucceeded TaggingWorkRequestSummaryStatusEnum = "SUCCEEDED"
TaggingWorkRequestSummaryStatusPartiallySucceeded TaggingWorkRequestSummaryStatusEnum = "PARTIALLY_SUCCEEDED"
TaggingWorkRequestSummaryStatusCanceling TaggingWorkRequestSummaryStatusEnum = "CANCELING"
TaggingWorkRequestSummaryStatusCanceled TaggingWorkRequestSummaryStatusEnum = "CANCELED"
)
func GetMappingTaggingWorkRequestSummaryStatusEnum(val string) (TaggingWorkRequestSummaryStatusEnum, bool)
GetMappingTaggingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTaggingWorkRequestSummaryStatusEnumValues() []TaggingWorkRequestSummaryStatusEnum
GetTaggingWorkRequestSummaryStatusEnumValues Enumerates the set of values for TaggingWorkRequestSummaryStatusEnum
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.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Tenancy) String() string
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
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.oracle.com/iaas/Content/Identity/usercred/usercredentials.htm).
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"`
}
func (m UiPassword) String() string
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
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.oracle.com/iaas/Content/Identity/Concepts/usercredentials.htm).
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"`
}
func (m UiPasswordInformation) String() string
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
UiPasswordInformationLifecycleStateEnum Enum with underlying type: string
type UiPasswordInformationLifecycleStateEnum string
Set of constants representing the allowable values for UiPasswordInformationLifecycleStateEnum
const (
UiPasswordInformationLifecycleStateCreating UiPasswordInformationLifecycleStateEnum = "CREATING"
UiPasswordInformationLifecycleStateActive UiPasswordInformationLifecycleStateEnum = "ACTIVE"
UiPasswordInformationLifecycleStateInactive UiPasswordInformationLifecycleStateEnum = "INACTIVE"
UiPasswordInformationLifecycleStateDeleting UiPasswordInformationLifecycleStateEnum = "DELETING"
UiPasswordInformationLifecycleStateDeleted UiPasswordInformationLifecycleStateEnum = "DELETED"
)
func GetMappingUiPasswordInformationLifecycleStateEnum(val string) (UiPasswordInformationLifecycleStateEnum, bool)
GetMappingUiPasswordInformationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUiPasswordInformationLifecycleStateEnumValues() []UiPasswordInformationLifecycleStateEnum
GetUiPasswordInformationLifecycleStateEnumValues Enumerates the set of values for UiPasswordInformationLifecycleStateEnum
UiPasswordLifecycleStateEnum Enum with underlying type: string
type UiPasswordLifecycleStateEnum string
Set of constants representing the allowable values for UiPasswordLifecycleStateEnum
const (
UiPasswordLifecycleStateCreating UiPasswordLifecycleStateEnum = "CREATING"
UiPasswordLifecycleStateActive UiPasswordLifecycleStateEnum = "ACTIVE"
UiPasswordLifecycleStateInactive UiPasswordLifecycleStateEnum = "INACTIVE"
UiPasswordLifecycleStateDeleting UiPasswordLifecycleStateEnum = "DELETING"
UiPasswordLifecycleStateDeleted UiPasswordLifecycleStateEnum = "DELETED"
)
func GetMappingUiPasswordLifecycleStateEnum(val string) (UiPasswordLifecycleStateEnum, bool)
GetMappingUiPasswordLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUiPasswordLifecycleStateEnumValues() []UiPasswordLifecycleStateEnum
GetUiPasswordLifecycleStateEnumValues Enumerates the set of values for UiPasswordLifecycleStateEnum
UpdateAuthTokenDetails The representation of 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"`
}
func (m UpdateAuthTokenDetails) String() string
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
UpdateAuthTokenRequest wrapper for the UpdateAuthToken operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateAuthToken.go.html to see an example of how to use 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
}
func (request UpdateAuthTokenRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAuthTokenRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAuthTokenRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAuthTokenRequest) String() string
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
UpdateAuthTokenResponse wrapper for the UpdateAuthToken operation
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"`
}
func (response UpdateAuthTokenResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAuthTokenResponse) String() string
UpdateAuthenticationPolicyDetails Update request for authentication policy, describes set of validation rules and their parameters to be updated.
type UpdateAuthenticationPolicyDetails struct {
PasswordPolicy *PasswordPolicy `mandatory:"false" json:"passwordPolicy"`
NetworkPolicy *NetworkPolicy `mandatory:"false" json:"networkPolicy"`
}
func (m UpdateAuthenticationPolicyDetails) String() string
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
UpdateAuthenticationPolicyRequest wrapper for the UpdateAuthenticationPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateAuthenticationPolicy.go.html to see an example of how to use 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
}
func (request UpdateAuthenticationPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAuthenticationPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAuthenticationPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAuthenticationPolicyRequest) String() string
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
UpdateAuthenticationPolicyResponse wrapper for the UpdateAuthenticationPolicy operation
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"`
}
func (response UpdateAuthenticationPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAuthenticationPolicyResponse) String() string
UpdateCompartmentDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateCompartmentDetails) String() string
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
UpdateCompartmentRequest wrapper for the UpdateCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateCompartment.go.html to see an example of how to use 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
}
func (request UpdateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCompartmentRequest) String() string
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
UpdateCompartmentResponse wrapper for the UpdateCompartment operation
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"`
}
func (response UpdateCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCompartmentResponse) String() string
UpdateCustomerSecretKeyDetails The representation of 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"`
}
func (m UpdateCustomerSecretKeyDetails) String() string
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
UpdateCustomerSecretKeyRequest wrapper for the UpdateCustomerSecretKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateCustomerSecretKey.go.html to see an example of how to use 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
}
func (request UpdateCustomerSecretKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCustomerSecretKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCustomerSecretKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCustomerSecretKeyRequest) String() string
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
UpdateCustomerSecretKeyResponse wrapper for the UpdateCustomerSecretKey operation
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"`
}
func (response UpdateCustomerSecretKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCustomerSecretKeyResponse) String() string
UpdateDomainDetails (For tenancies that support identity domains) Update identity domain details.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDomainDetails) String() string
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
UpdateDomainRequest wrapper for the UpdateDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateDomain.go.html to see an example of how to use 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
}
func (request UpdateDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDomainRequest) String() string
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
UpdateDomainResponse wrapper for the UpdateDomain operation
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDomainResponse) String() string
UpdateDynamicGroupDetails Properties for updating a dynamic group.
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDynamicGroupDetails) String() string
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
UpdateDynamicGroupRequest wrapper for the UpdateDynamicGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateDynamicGroup.go.html to see an example of how to use 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
}
func (request UpdateDynamicGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDynamicGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDynamicGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDynamicGroupRequest) String() string
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
UpdateDynamicGroupResponse wrapper for the UpdateDynamicGroup operation
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"`
}
func (response UpdateDynamicGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDynamicGroupResponse) String() string
UpdateGroupDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateGroupDetails) String() string
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
UpdateGroupRequest wrapper for the UpdateGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateGroup.go.html to see an example of how to use 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
}
func (request UpdateGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGroupRequest) String() string
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
UpdateGroupResponse wrapper for the UpdateGroup operation
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"`
}
func (response UpdateGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGroupResponse) String() string
UpdateIdentityProviderDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
GetDefinedTags() map[string]map[string]interface{}
}
UpdateIdentityProviderDetailsProtocolEnum Enum with underlying type: string
type UpdateIdentityProviderDetailsProtocolEnum string
Set of constants representing the allowable values for UpdateIdentityProviderDetailsProtocolEnum
const (
UpdateIdentityProviderDetailsProtocolSaml2 UpdateIdentityProviderDetailsProtocolEnum = "SAML2"
)
func GetMappingUpdateIdentityProviderDetailsProtocolEnum(val string) (UpdateIdentityProviderDetailsProtocolEnum, bool)
GetMappingUpdateIdentityProviderDetailsProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateIdentityProviderDetailsProtocolEnumValues() []UpdateIdentityProviderDetailsProtocolEnum
GetUpdateIdentityProviderDetailsProtocolEnumValues Enumerates the set of values for UpdateIdentityProviderDetailsProtocolEnum
UpdateIdentityProviderRequest wrapper for the UpdateIdentityProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateIdentityProvider.go.html to see an example of how to use 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
}
func (request UpdateIdentityProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateIdentityProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateIdentityProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateIdentityProviderRequest) String() string
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
UpdateIdentityProviderResponse wrapper for the UpdateIdentityProvider operation
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"`
}
func (response UpdateIdentityProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateIdentityProviderResponse) String() string
UpdateIdpGroupMappingDetails The representation of 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"`
}
func (m UpdateIdpGroupMappingDetails) String() string
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
UpdateIdpGroupMappingRequest wrapper for the UpdateIdpGroupMapping operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateIdpGroupMapping.go.html to see an example of how to use 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
}
func (request UpdateIdpGroupMappingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateIdpGroupMappingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateIdpGroupMappingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateIdpGroupMappingRequest) String() string
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
UpdateIdpGroupMappingResponse wrapper for the UpdateIdpGroupMapping operation
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"`
}
func (response UpdateIdpGroupMappingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateIdpGroupMappingResponse) String() string
UpdateNetworkSourceDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateNetworkSourceDetails) String() string
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
UpdateNetworkSourceRequest wrapper for the UpdateNetworkSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateNetworkSource.go.html to see an example of how to use 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
}
func (request UpdateNetworkSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateNetworkSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateNetworkSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateNetworkSourceRequest) String() string
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
UpdateNetworkSourceResponse wrapper for the UpdateNetworkSource operation
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"`
}
func (response UpdateNetworkSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateNetworkSourceResponse) String() string
UpdateOAuth2ClientCredentialDetails The representation of 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"`
}
func (m UpdateOAuth2ClientCredentialDetails) String() string
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
UpdateOAuthClientCredentialRequest wrapper for the UpdateOAuthClientCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateOAuthClientCredential.go.html to see an example of how to use 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
}
func (request UpdateOAuthClientCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOAuthClientCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOAuthClientCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOAuthClientCredentialRequest) String() string
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
UpdateOAuthClientCredentialResponse wrapper for the UpdateOAuthClientCredential operation
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"`
}
func (response UpdateOAuthClientCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOAuthClientCredentialResponse) String() string
UpdatePolicyDetails The representation of 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.oracle.com/iaas/Content/Identity/policieshow/how-policies-work.htm) and
// Common Policies (https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdatePolicyDetails) String() string
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
UpdatePolicyRequest wrapper for the UpdatePolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdatePolicy.go.html to see an example of how to use 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
}
func (request UpdatePolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePolicyRequest) String() string
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
UpdatePolicyResponse wrapper for the UpdatePolicy operation
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"`
}
func (response UpdatePolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePolicyResponse) String() string
UpdateSaml2IdentityProviderDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m UpdateSaml2IdentityProviderDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateSaml2IdentityProviderDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateSaml2IdentityProviderDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateSaml2IdentityProviderDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateSaml2IdentityProviderDetails) String() string
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
UpdateSmtpCredentialDetails The representation of 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"`
}
func (m UpdateSmtpCredentialDetails) String() string
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
UpdateSmtpCredentialRequest wrapper for the UpdateSmtpCredential operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateSmtpCredential.go.html to see an example of how to use 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
}
func (request UpdateSmtpCredentialRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSmtpCredentialRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSmtpCredentialRequest) String() string
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
UpdateSmtpCredentialResponse wrapper for the UpdateSmtpCredential operation
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"`
}
func (response UpdateSmtpCredentialResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSmtpCredentialResponse) String() string
UpdateStateDetails The representation of 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"`
}
func (m UpdateStateDetails) String() string
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
UpdateSwiftPasswordDetails The representation of 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"`
}
func (m UpdateSwiftPasswordDetails) String() string
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
UpdateSwiftPasswordRequest wrapper for the UpdateSwiftPassword operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateSwiftPassword.go.html to see an example of how to use 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
}
func (request UpdateSwiftPasswordRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSwiftPasswordRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSwiftPasswordRequest) String() string
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
UpdateSwiftPasswordResponse wrapper for the UpdateSwiftPassword operation
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"`
}
func (response UpdateSwiftPasswordResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSwiftPasswordResponse) String() string
UpdateTagDefaultDetails The representation of 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"`
}
func (m UpdateTagDefaultDetails) String() string
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
UpdateTagDefaultRequest wrapper for the UpdateTagDefault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTagDefault.go.html to see an example of how to use 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
}
func (request UpdateTagDefaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTagDefaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTagDefaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTagDefaultRequest) String() string
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
UpdateTagDefaultResponse wrapper for the UpdateTagDefault operation
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"`
}
func (response UpdateTagDefaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTagDefaultResponse) String() string
UpdateTagDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m UpdateTagDetails) String() string
func (m *UpdateTagDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
UpdateTagNamespaceDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateTagNamespaceDetails) String() string
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
UpdateTagNamespaceRequest wrapper for the UpdateTagNamespace operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTagNamespace.go.html to see an example of how to use 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
}
func (request UpdateTagNamespaceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTagNamespaceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTagNamespaceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTagNamespaceRequest) String() string
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
UpdateTagNamespaceResponse wrapper for the UpdateTagNamespace operation
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"`
}
func (response UpdateTagNamespaceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTagNamespaceResponse) String() string
UpdateTagRequest wrapper for the UpdateTag operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateTag.go.html to see an example of how to use 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
}
func (request UpdateTagRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTagRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTagRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTagRequest) String() string
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
UpdateTagResponse wrapper for the UpdateTag operation
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"`
}
func (response UpdateTagResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTagResponse) String() string
UpdateUserCapabilitiesDetails The representation of 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"`
}
func (m UpdateUserCapabilitiesDetails) String() string
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
UpdateUserCapabilitiesRequest wrapper for the UpdateUserCapabilities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUserCapabilities.go.html to see an example of how to use 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
}
func (request UpdateUserCapabilitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateUserCapabilitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateUserCapabilitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateUserCapabilitiesRequest) String() string
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
UpdateUserCapabilitiesResponse wrapper for the UpdateUserCapabilities operation
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"`
}
func (response UpdateUserCapabilitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateUserCapabilitiesResponse) String() string
UpdateUserDetails The representation of 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateUserDetails) String() string
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
UpdateUserRequest wrapper for the UpdateUser operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUser.go.html to see an example of how to use 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
}
func (request UpdateUserRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateUserRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateUserRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateUserRequest) String() string
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
UpdateUserResponse wrapper for the UpdateUser operation
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"`
}
func (response UpdateUserResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateUserResponse) String() string
UpdateUserStateRequest wrapper for the UpdateUserState operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UpdateUserState.go.html to see an example of how to use 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
}
func (request UpdateUserStateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateUserStateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateUserStateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateUserStateRequest) String() string
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
UpdateUserStateResponse wrapper for the UpdateUserState operation
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"`
}
func (response UpdateUserStateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateUserStateResponse) String() string
UploadApiKeyRequest wrapper for the UploadApiKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/identity/UploadApiKey.go.html to see an example of how to use 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
}
func (request UploadApiKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UploadApiKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UploadApiKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UploadApiKeyRequest) String() string
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
UploadApiKeyResponse wrapper for the UploadApiKey operation
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"`
}
func (response UploadApiKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UploadApiKeyResponse) String() string
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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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 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.oracle.com/iaas/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.oracle.com/iaas/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"`
}
func (m User) String() string
func (m User) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UserCapabilities Properties indicating how the user is allowed to authenticate.
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"`
}
func (m UserCapabilities) String() string
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
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.
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"`
}
func (m UserGroupMembership) String() string
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
UserGroupMembershipLifecycleStateEnum Enum with underlying type: string
type UserGroupMembershipLifecycleStateEnum string
Set of constants representing the allowable values for UserGroupMembershipLifecycleStateEnum
const (
UserGroupMembershipLifecycleStateCreating UserGroupMembershipLifecycleStateEnum = "CREATING"
UserGroupMembershipLifecycleStateActive UserGroupMembershipLifecycleStateEnum = "ACTIVE"
UserGroupMembershipLifecycleStateInactive UserGroupMembershipLifecycleStateEnum = "INACTIVE"
UserGroupMembershipLifecycleStateDeleting UserGroupMembershipLifecycleStateEnum = "DELETING"
UserGroupMembershipLifecycleStateDeleted UserGroupMembershipLifecycleStateEnum = "DELETED"
)
func GetMappingUserGroupMembershipLifecycleStateEnum(val string) (UserGroupMembershipLifecycleStateEnum, bool)
GetMappingUserGroupMembershipLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUserGroupMembershipLifecycleStateEnumValues() []UserGroupMembershipLifecycleStateEnum
GetUserGroupMembershipLifecycleStateEnumValues Enumerates the set of values for UserGroupMembershipLifecycleStateEnum
UserLifecycleStateEnum Enum with underlying type: string
type UserLifecycleStateEnum string
Set of constants representing the allowable values for UserLifecycleStateEnum
const (
UserLifecycleStateCreating UserLifecycleStateEnum = "CREATING"
UserLifecycleStateActive UserLifecycleStateEnum = "ACTIVE"
UserLifecycleStateInactive UserLifecycleStateEnum = "INACTIVE"
UserLifecycleStateDeleting UserLifecycleStateEnum = "DELETING"
UserLifecycleStateDeleted UserLifecycleStateEnum = "DELETED"
)
func GetMappingUserLifecycleStateEnum(val string) (UserLifecycleStateEnum, bool)
GetMappingUserLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUserLifecycleStateEnumValues() []UserLifecycleStateEnum
GetUserLifecycleStateEnumValues Enumerates the set of values for UserLifecycleStateEnum
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.
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"`
}
func (m WorkRequest) String() string
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
WorkRequestError The error entity.
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"`
}
func (m WorkRequestError) String() string
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
WorkRequestLogEntry The log entity.
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"`
}
func (m WorkRequestLogEntry) String() string
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
WorkRequestOperationTypeEnum Enum with underlying type: string
type WorkRequestOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestOperationTypeEnum
const (
WorkRequestOperationTypeCompartment WorkRequestOperationTypeEnum = "DELETE_COMPARTMENT"
WorkRequestOperationTypeTagDefinition WorkRequestOperationTypeEnum = "DELETE_TAG_DEFINITION"
)
func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)
GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum
WorkRequestResource The resource entity.
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"`
}
func (m WorkRequestResource) String() string
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
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeRelated WorkRequestResourceActionTypeEnum = "RELATED"
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeFailed WorkRequestResourceActionTypeEnum = "FAILED"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary The work request summary. Tracks the status of the asynchronous operation.
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"`
}
func (m WorkRequestSummary) String() string
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
WorkRequestSummaryOperationTypeEnum Enum with underlying type: string
type WorkRequestSummaryOperationTypeEnum string
Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum
const (
WorkRequestSummaryOperationTypeCompartment WorkRequestSummaryOperationTypeEnum = "DELETE_COMPARTMENT"
WorkRequestSummaryOperationTypeTagDefinition WorkRequestSummaryOperationTypeEnum = "DELETE_TAG_DEFINITION"
)
func GetMappingWorkRequestSummaryOperationTypeEnum(val string) (WorkRequestSummaryOperationTypeEnum, bool)
GetMappingWorkRequestSummaryOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum
GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum
WorkRequestSummaryStatusEnum Enum with underlying type: string
type WorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for WorkRequestSummaryStatusEnum
const (
WorkRequestSummaryStatusAccepted WorkRequestSummaryStatusEnum = "ACCEPTED"
WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
WorkRequestSummaryStatusFailed WorkRequestSummaryStatusEnum = "FAILED"
WorkRequestSummaryStatusSucceeded WorkRequestSummaryStatusEnum = "SUCCEEDED"
WorkRequestSummaryStatusCanceling WorkRequestSummaryStatusEnum = "CANCELING"
WorkRequestSummaryStatusCanceled WorkRequestSummaryStatusEnum = "CANCELED"
)
func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)
GetMappingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum