oci-go-sdk: github.com/oracle/oci-go-sdk/identity Index | Files

package identity

import "github.com/oracle/oci-go-sdk/identity"

Index

Package Files

activate_mfa_totp_device_request_response.go add_user_to_group_details.go add_user_to_group_request_response.go api_key.go assemble_effective_tag_set_request_response.go auth_token.go authentication_policy.go availability_domain.go base_tag_definition_validator.go bulk_action_resource.go bulk_action_resource_type.go bulk_action_resource_type_collection.go bulk_delete_resources_details.go bulk_delete_resources_request_response.go bulk_delete_tags_details.go bulk_delete_tags_request_response.go bulk_move_resources_details.go bulk_move_resources_request_response.go cascade_delete_tag_namespace_request_response.go change_tag_namespace_compartment_detail.go change_tag_namespace_compartment_request_response.go compartment.go create_api_key_details.go create_auth_token_details.go create_auth_token_request_response.go create_compartment_details.go create_compartment_request_response.go create_customer_secret_key_details.go create_customer_secret_key_request_response.go create_dynamic_group_details.go create_dynamic_group_request_response.go create_group_details.go create_group_request_response.go create_identity_provider_details.go create_identity_provider_request_response.go create_idp_group_mapping_details.go create_idp_group_mapping_request_response.go create_mfa_totp_device_request_response.go create_network_source_details.go create_network_source_request_response.go create_o_auth2_client_credential_details.go create_o_auth_client_credential_request_response.go create_or_reset_u_i_password_request_response.go create_policy_details.go create_policy_request_response.go create_region_subscription_details.go create_region_subscription_request_response.go create_saml2_identity_provider_details.go create_smtp_credential_details.go create_smtp_credential_request_response.go create_swift_password_details.go create_swift_password_request_response.go create_tag_default_details.go create_tag_default_request_response.go create_tag_details.go create_tag_namespace_details.go create_tag_namespace_request_response.go create_tag_request_response.go create_user_details.go create_user_request_response.go customer_secret_key.go customer_secret_key_summary.go default_tag_definition_validator.go delete_api_key_request_response.go delete_auth_token_request_response.go delete_compartment_request_response.go delete_customer_secret_key_request_response.go delete_dynamic_group_request_response.go delete_group_request_response.go delete_identity_provider_request_response.go delete_idp_group_mapping_request_response.go delete_mfa_totp_device_request_response.go delete_network_source_request_response.go delete_o_auth_client_credential_request_response.go delete_policy_request_response.go delete_smtp_credential_request_response.go delete_swift_password_request_response.go delete_tag_default_request_response.go delete_tag_namespace_request_response.go delete_tag_request_response.go delete_user_request_response.go dynamic_group.go enum_tag_definition_validator.go fault_domain.go fully_qualified_scope.go generate_totp_seed_request_response.go get_authentication_policy_request_response.go get_compartment_request_response.go get_dynamic_group_request_response.go get_group_request_response.go get_identity_provider_request_response.go get_idp_group_mapping_request_response.go get_mfa_totp_device_request_response.go get_network_source_request_response.go get_policy_request_response.go get_tag_default_request_response.go get_tag_namespace_request_response.go get_tag_request_response.go get_tagging_work_request_request_response.go get_tenancy_request_response.go get_user_group_membership_request_response.go get_user_request_response.go get_user_u_i_password_information_request_response.go get_work_request_request_response.go group.go identity_client.go identity_provider.go identity_provider_group_summary.go idp_group_mapping.go list_api_keys_request_response.go list_auth_tokens_request_response.go list_availability_domains_request_response.go list_bulk_action_resource_types_request_response.go list_compartments_request_response.go list_cost_tracking_tags_request_response.go list_customer_secret_keys_request_response.go list_dynamic_groups_request_response.go list_fault_domains_request_response.go list_groups_request_response.go list_identity_provider_groups_request_response.go list_identity_providers_request_response.go list_idp_group_mappings_request_response.go list_mfa_totp_devices_request_response.go list_network_sources_request_response.go list_o_auth_client_credentials_request_response.go list_policies_request_response.go list_region_subscriptions_request_response.go list_regions_request_response.go list_smtp_credentials_request_response.go list_swift_passwords_request_response.go list_tag_defaults_request_response.go list_tag_namespaces_request_response.go list_tagging_work_request_errors_request_response.go list_tagging_work_request_logs_request_response.go list_tagging_work_requests_request_response.go list_tags_request_response.go list_user_group_memberships_request_response.go list_users_request_response.go list_work_requests_request_response.go mfa_totp_device.go mfa_totp_device_summary.go mfa_totp_token.go move_compartment_details.go move_compartment_request_response.go network_policy.go network_sources.go network_sources_summary.go network_sources_virtual_source_list.go o_auth2_client_credential.go o_auth2_client_credential_summary.go password_policy.go policy.go recover_compartment_request_response.go region.go region_subscription.go remove_user_from_group_request_response.go reset_idp_scim_client_request_response.go saml2_identity_provider.go scim_client_credentials.go smtp_credential.go smtp_credential_summary.go swift_password.go tag.go tag_default.go tag_default_summary.go tag_namespace.go tag_namespace_summary.go tag_summary.go tagging_work_request.go tagging_work_request_error_summary.go tagging_work_request_log_summary.go tagging_work_request_summary.go tenancy.go ui_password.go ui_password_information.go update_auth_token_details.go update_auth_token_request_response.go update_authentication_policy_details.go update_authentication_policy_request_response.go update_compartment_details.go update_compartment_request_response.go update_customer_secret_key_details.go update_customer_secret_key_request_response.go update_dynamic_group_details.go update_dynamic_group_request_response.go update_group_details.go update_group_request_response.go update_identity_provider_details.go update_identity_provider_request_response.go update_idp_group_mapping_details.go update_idp_group_mapping_request_response.go update_network_source_details.go update_network_source_request_response.go update_o_auth2_client_credential_details.go update_o_auth_client_credential_request_response.go update_policy_details.go update_policy_request_response.go update_saml2_identity_provider_details.go update_smtp_credential_details.go update_smtp_credential_request_response.go update_state_details.go update_swift_password_details.go update_swift_password_request_response.go update_tag_default_details.go update_tag_default_request_response.go update_tag_details.go update_tag_namespace_details.go update_tag_namespace_request_response.go update_tag_request_response.go update_user_capabilities_details.go update_user_capabilities_request_response.go update_user_details.go update_user_request_response.go update_user_state_request_response.go upload_api_key_request_response.go user.go user_capabilities.go user_group_membership.go work_request.go work_request_error.go work_request_log_entry.go work_request_resource.go work_request_summary.go

type ActivateMfaTotpDeviceRequest Uses

type ActivateMfaTotpDeviceRequest struct {

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

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

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ActivateMfaTotpDeviceRequest wrapper for the ActivateMfaTotpDevice operation

func (ActivateMfaTotpDeviceRequest) HTTPRequest Uses

func (request ActivateMfaTotpDeviceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ActivateMfaTotpDeviceRequest) RetryPolicy Uses

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

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

func (ActivateMfaTotpDeviceRequest) String Uses

func (request ActivateMfaTotpDeviceRequest) String() string

type ActivateMfaTotpDeviceResponse Uses

type ActivateMfaTotpDeviceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

ActivateMfaTotpDeviceResponse wrapper for the ActivateMfaTotpDevice operation

func (ActivateMfaTotpDeviceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ActivateMfaTotpDeviceResponse) String Uses

func (response ActivateMfaTotpDeviceResponse) String() string

type AddUserToGroupDetails Uses

type AddUserToGroupDetails struct {

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

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

AddUserToGroupDetails The representation of AddUserToGroupDetails

func (AddUserToGroupDetails) String Uses

func (m AddUserToGroupDetails) String() string

type AddUserToGroupRequest Uses

type AddUserToGroupRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

AddUserToGroupRequest wrapper for the AddUserToGroup operation

func (AddUserToGroupRequest) HTTPRequest Uses

func (request AddUserToGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AddUserToGroupRequest) RetryPolicy Uses

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

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

func (AddUserToGroupRequest) String Uses

func (request AddUserToGroupRequest) String() string

type AddUserToGroupResponse Uses

type AddUserToGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

AddUserToGroupResponse wrapper for the AddUserToGroup operation

func (AddUserToGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (AddUserToGroupResponse) String Uses

func (response AddUserToGroupResponse) String() string

type ApiKey Uses

type ApiKey struct {

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

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

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

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

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

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

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

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

func (ApiKey) String Uses

func (m ApiKey) String() string

type ApiKeyLifecycleStateEnum Uses

type ApiKeyLifecycleStateEnum string

ApiKeyLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for ApiKeyLifecycleStateEnum

func GetApiKeyLifecycleStateEnumValues Uses

func GetApiKeyLifecycleStateEnumValues() []ApiKeyLifecycleStateEnum

GetApiKeyLifecycleStateEnumValues Enumerates the set of values for ApiKeyLifecycleStateEnum

type AssembleEffectiveTagSetRequest Uses

type AssembleEffectiveTagSetRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

AssembleEffectiveTagSetRequest wrapper for the AssembleEffectiveTagSet operation

func (AssembleEffectiveTagSetRequest) HTTPRequest Uses

func (request AssembleEffectiveTagSetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AssembleEffectiveTagSetRequest) RetryPolicy Uses

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

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

func (AssembleEffectiveTagSetRequest) String Uses

func (request AssembleEffectiveTagSetRequest) String() string

type AssembleEffectiveTagSetResponse Uses

type AssembleEffectiveTagSetResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The []TagDefaultSummary instance
    Items []TagDefaultSummary `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

AssembleEffectiveTagSetResponse wrapper for the AssembleEffectiveTagSet operation

func (AssembleEffectiveTagSetResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (AssembleEffectiveTagSetResponse) String Uses

func (response AssembleEffectiveTagSetResponse) String() string

type AuthToken Uses

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.
    Description *string `mandatory:"false" json:"description"`

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

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

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

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

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

func (AuthToken) String Uses

func (m AuthToken) String() string

type AuthTokenLifecycleStateEnum Uses

type AuthTokenLifecycleStateEnum string

AuthTokenLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AuthTokenLifecycleStateEnum

func GetAuthTokenLifecycleStateEnumValues Uses

func GetAuthTokenLifecycleStateEnumValues() []AuthTokenLifecycleStateEnum

GetAuthTokenLifecycleStateEnumValues Enumerates the set of values for AuthTokenLifecycleStateEnum

type AuthenticationPolicy Uses

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

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

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

AuthenticationPolicy Authentication policy, currently set for the given compartment

func (AuthenticationPolicy) String Uses

func (m AuthenticationPolicy) String() string

type AvailabilityDomain Uses

type AvailabilityDomain struct {

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

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

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

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

func (AvailabilityDomain) String Uses

func (m AvailabilityDomain) String() string

type BaseTagDefinitionValidator Uses

type BaseTagDefinitionValidator interface {
}

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

type BaseTagDefinitionValidatorValidatorTypeEnum Uses

type BaseTagDefinitionValidatorValidatorTypeEnum string

BaseTagDefinitionValidatorValidatorTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for BaseTagDefinitionValidatorValidatorTypeEnum

func GetBaseTagDefinitionValidatorValidatorTypeEnumValues Uses

func GetBaseTagDefinitionValidatorValidatorTypeEnumValues() []BaseTagDefinitionValidatorValidatorTypeEnum

GetBaseTagDefinitionValidatorValidatorTypeEnumValues Enumerates the set of values for BaseTagDefinitionValidatorValidatorTypeEnum

type BulkActionResource Uses

type BulkActionResource struct {

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

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

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

BulkActionResource The bulk action resource entity.

func (BulkActionResource) String Uses

func (m BulkActionResource) String() string

type BulkActionResourceType Uses

type BulkActionResourceType struct {

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

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

BulkActionResourceType The representation of BulkActionResourceType

func (BulkActionResourceType) String Uses

func (m BulkActionResourceType) String() string

type BulkActionResourceTypeCollection Uses

type BulkActionResourceTypeCollection struct {

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

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

func (BulkActionResourceTypeCollection) String Uses

func (m BulkActionResourceTypeCollection) String() string

type BulkDeleteResourcesDetails Uses

type BulkDeleteResourcesDetails struct {

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

BulkDeleteResourcesDetails The representation of BulkDeleteResourcesDetails

func (BulkDeleteResourcesDetails) String Uses

func (m BulkDeleteResourcesDetails) String() string

type BulkDeleteResourcesRequest Uses

type BulkDeleteResourcesRequest struct {

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

    // Request object for bulk delete resources in a compartment.
    BulkDeleteResourcesDetails `contributesTo:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

BulkDeleteResourcesRequest wrapper for the BulkDeleteResources operation

func (BulkDeleteResourcesRequest) HTTPRequest Uses

func (request BulkDeleteResourcesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkDeleteResourcesRequest) RetryPolicy Uses

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

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

func (BulkDeleteResourcesRequest) String Uses

func (request BulkDeleteResourcesRequest) String() string

type BulkDeleteResourcesResponse Uses

type BulkDeleteResourcesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

BulkDeleteResourcesResponse wrapper for the BulkDeleteResources operation

func (BulkDeleteResourcesResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (BulkDeleteResourcesResponse) String Uses

func (response BulkDeleteResourcesResponse) String() string

type BulkDeleteTagsDetails Uses

type BulkDeleteTagsDetails struct {

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

BulkDeleteTagsDetails Properties for deleting tags in bulk

func (BulkDeleteTagsDetails) String Uses

func (m BulkDeleteTagsDetails) String() string

type BulkDeleteTagsRequest Uses

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

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

BulkDeleteTagsRequest wrapper for the BulkDeleteTags operation

func (BulkDeleteTagsRequest) HTTPRequest Uses

func (request BulkDeleteTagsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkDeleteTagsRequest) RetryPolicy Uses

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

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

func (BulkDeleteTagsRequest) String Uses

func (request BulkDeleteTagsRequest) String() string

type BulkDeleteTagsResponse Uses

type BulkDeleteTagsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

BulkDeleteTagsResponse wrapper for the BulkDeleteTags operation

func (BulkDeleteTagsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (BulkDeleteTagsResponse) String Uses

func (response BulkDeleteTagsResponse) String() string

type BulkMoveResourcesDetails Uses

type BulkMoveResourcesDetails struct {

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

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

BulkMoveResourcesDetails The representation of BulkMoveResourcesDetails

func (BulkMoveResourcesDetails) String Uses

func (m BulkMoveResourcesDetails) String() string

type BulkMoveResourcesRequest Uses

type BulkMoveResourcesRequest struct {

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

    // Request object for bulk move resources in the compartment.
    BulkMoveResourcesDetails `contributesTo:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

BulkMoveResourcesRequest wrapper for the BulkMoveResources operation

func (BulkMoveResourcesRequest) HTTPRequest Uses

func (request BulkMoveResourcesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkMoveResourcesRequest) RetryPolicy Uses

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

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

func (BulkMoveResourcesRequest) String Uses

func (request BulkMoveResourcesRequest) String() string

type BulkMoveResourcesResponse Uses

type BulkMoveResourcesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

BulkMoveResourcesResponse wrapper for the BulkMoveResources operation

func (BulkMoveResourcesResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (BulkMoveResourcesResponse) String Uses

func (response BulkMoveResourcesResponse) String() string

type CascadeDeleteTagNamespaceRequest Uses

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

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CascadeDeleteTagNamespaceRequest wrapper for the CascadeDeleteTagNamespace operation

func (CascadeDeleteTagNamespaceRequest) HTTPRequest Uses

func (request CascadeDeleteTagNamespaceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CascadeDeleteTagNamespaceRequest) RetryPolicy Uses

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

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

func (CascadeDeleteTagNamespaceRequest) String Uses

func (request CascadeDeleteTagNamespaceRequest) String() string

type CascadeDeleteTagNamespaceResponse Uses

type CascadeDeleteTagNamespaceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CascadeDeleteTagNamespaceResponse wrapper for the CascadeDeleteTagNamespace operation

func (CascadeDeleteTagNamespaceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CascadeDeleteTagNamespaceResponse) String Uses

func (response CascadeDeleteTagNamespaceResponse) String() string

type ChangeTagNamespaceCompartmentDetail Uses

type ChangeTagNamespaceCompartmentDetail struct {

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

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

func (ChangeTagNamespaceCompartmentDetail) String Uses

func (m ChangeTagNamespaceCompartmentDetail) String() string

type ChangeTagNamespaceCompartmentRequest Uses

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

ChangeTagNamespaceCompartmentRequest wrapper for the ChangeTagNamespaceCompartment operation

func (ChangeTagNamespaceCompartmentRequest) HTTPRequest Uses

func (request ChangeTagNamespaceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeTagNamespaceCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeTagNamespaceCompartmentRequest) String Uses

func (request ChangeTagNamespaceCompartmentRequest) String() string

type ChangeTagNamespaceCompartmentResponse Uses

type ChangeTagNamespaceCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeTagNamespaceCompartmentResponse wrapper for the ChangeTagNamespaceCompartment operation

func (ChangeTagNamespaceCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeTagNamespaceCompartmentResponse) String Uses

func (response ChangeTagNamespaceCompartmentResponse) String() string

type Compartment Uses

type Compartment struct {

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

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

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

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

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

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

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

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

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

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

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

func (Compartment) String Uses

func (m Compartment) String() string

type CompartmentLifecycleStateEnum Uses

type CompartmentLifecycleStateEnum string

CompartmentLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CompartmentLifecycleStateEnum

func GetCompartmentLifecycleStateEnumValues Uses

func GetCompartmentLifecycleStateEnumValues() []CompartmentLifecycleStateEnum

GetCompartmentLifecycleStateEnumValues Enumerates the set of values for CompartmentLifecycleStateEnum

type CreateApiKeyDetails Uses

type CreateApiKeyDetails struct {

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

CreateApiKeyDetails The representation of CreateApiKeyDetails

func (CreateApiKeyDetails) String Uses

func (m CreateApiKeyDetails) String() string

type CreateAuthTokenDetails Uses

type CreateAuthTokenDetails struct {

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

CreateAuthTokenDetails The representation of CreateAuthTokenDetails

func (CreateAuthTokenDetails) String Uses

func (m CreateAuthTokenDetails) String() string

type CreateAuthTokenRequest Uses

type CreateAuthTokenRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateAuthTokenRequest wrapper for the CreateAuthToken operation

func (CreateAuthTokenRequest) HTTPRequest Uses

func (request CreateAuthTokenRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAuthTokenRequest) RetryPolicy Uses

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

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

func (CreateAuthTokenRequest) String Uses

func (request CreateAuthTokenRequest) String() string

type CreateAuthTokenResponse Uses

type CreateAuthTokenResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateAuthTokenResponse wrapper for the CreateAuthToken operation

func (CreateAuthTokenResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateAuthTokenResponse) String Uses

func (response CreateAuthTokenResponse) String() string

type CreateCompartmentDetails Uses

type CreateCompartmentDetails struct {

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

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

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

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

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

CreateCompartmentDetails The representation of CreateCompartmentDetails

func (CreateCompartmentDetails) String Uses

func (m CreateCompartmentDetails) String() string

type CreateCompartmentRequest Uses

type CreateCompartmentRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateCompartmentRequest wrapper for the CreateCompartment operation

func (CreateCompartmentRequest) HTTPRequest Uses

func (request CreateCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCompartmentRequest) RetryPolicy Uses

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

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

func (CreateCompartmentRequest) String Uses

func (request CreateCompartmentRequest) String() string

type CreateCompartmentResponse Uses

type CreateCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateCompartmentResponse wrapper for the CreateCompartment operation

func (CreateCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateCompartmentResponse) String Uses

func (response CreateCompartmentResponse) String() string

type CreateCustomerSecretKeyDetails Uses

type CreateCustomerSecretKeyDetails struct {

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

CreateCustomerSecretKeyDetails The representation of CreateCustomerSecretKeyDetails

func (CreateCustomerSecretKeyDetails) String Uses

func (m CreateCustomerSecretKeyDetails) String() string

type CreateCustomerSecretKeyRequest Uses

type CreateCustomerSecretKeyRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateCustomerSecretKeyRequest wrapper for the CreateCustomerSecretKey operation

func (CreateCustomerSecretKeyRequest) HTTPRequest Uses

func (request CreateCustomerSecretKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCustomerSecretKeyRequest) RetryPolicy Uses

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

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

func (CreateCustomerSecretKeyRequest) String Uses

func (request CreateCustomerSecretKeyRequest) String() string

type CreateCustomerSecretKeyResponse Uses

type CreateCustomerSecretKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateCustomerSecretKeyResponse wrapper for the CreateCustomerSecretKey operation

func (CreateCustomerSecretKeyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateCustomerSecretKeyResponse) String Uses

func (response CreateCustomerSecretKeyResponse) String() string

type CreateDynamicGroupDetails Uses

type CreateDynamicGroupDetails struct {

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

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

    // The matching rule to dynamically match an instance certificate to this dynamic group.
    // For rule syntax, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/Tasks/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.
    Description *string `mandatory:"true" json:"description"`

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

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

CreateDynamicGroupDetails Properties for creating a dynamic group.

func (CreateDynamicGroupDetails) String Uses

func (m CreateDynamicGroupDetails) String() string

type CreateDynamicGroupRequest Uses

type CreateDynamicGroupRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateDynamicGroupRequest wrapper for the CreateDynamicGroup operation

func (CreateDynamicGroupRequest) HTTPRequest Uses

func (request CreateDynamicGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDynamicGroupRequest) RetryPolicy Uses

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

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

func (CreateDynamicGroupRequest) String Uses

func (request CreateDynamicGroupRequest) String() string

type CreateDynamicGroupResponse Uses

type CreateDynamicGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateDynamicGroupResponse wrapper for the CreateDynamicGroup operation

func (CreateDynamicGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateDynamicGroupResponse) String Uses

func (response CreateDynamicGroupResponse) String() string

type CreateGroupDetails Uses

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.
    Description *string `mandatory:"true" json:"description"`

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

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

CreateGroupDetails The representation of CreateGroupDetails

func (CreateGroupDetails) String Uses

func (m CreateGroupDetails) String() string

type CreateGroupRequest Uses

type CreateGroupRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateGroupRequest wrapper for the CreateGroup operation

func (CreateGroupRequest) HTTPRequest Uses

func (request CreateGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateGroupRequest) RetryPolicy Uses

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

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

func (CreateGroupRequest) String Uses

func (request CreateGroupRequest) String() string

type CreateGroupResponse Uses

type CreateGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateGroupResponse wrapper for the CreateGroup operation

func (CreateGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateGroupResponse) String Uses

func (response CreateGroupResponse) String() string

type CreateIdentityProviderDetails Uses

type CreateIdentityProviderDetails interface {

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

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

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

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

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

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

CreateIdentityProviderDetails The representation of CreateIdentityProviderDetails

type CreateIdentityProviderDetailsProductTypeEnum Uses

type CreateIdentityProviderDetailsProductTypeEnum string

CreateIdentityProviderDetailsProductTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CreateIdentityProviderDetailsProductTypeEnum

func GetCreateIdentityProviderDetailsProductTypeEnumValues Uses

func GetCreateIdentityProviderDetailsProductTypeEnumValues() []CreateIdentityProviderDetailsProductTypeEnum

GetCreateIdentityProviderDetailsProductTypeEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProductTypeEnum

type CreateIdentityProviderDetailsProtocolEnum Uses

type CreateIdentityProviderDetailsProtocolEnum string

CreateIdentityProviderDetailsProtocolEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CreateIdentityProviderDetailsProtocolEnum

func GetCreateIdentityProviderDetailsProtocolEnumValues Uses

func GetCreateIdentityProviderDetailsProtocolEnumValues() []CreateIdentityProviderDetailsProtocolEnum

GetCreateIdentityProviderDetailsProtocolEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProtocolEnum

type CreateIdentityProviderRequest Uses

type CreateIdentityProviderRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateIdentityProviderRequest wrapper for the CreateIdentityProvider operation

func (CreateIdentityProviderRequest) HTTPRequest Uses

func (request CreateIdentityProviderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIdentityProviderRequest) RetryPolicy Uses

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

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

func (CreateIdentityProviderRequest) String Uses

func (request CreateIdentityProviderRequest) String() string

type CreateIdentityProviderResponse Uses

type CreateIdentityProviderResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateIdentityProviderResponse wrapper for the CreateIdentityProvider operation

func (CreateIdentityProviderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateIdentityProviderResponse) String Uses

func (response CreateIdentityProviderResponse) String() string

type CreateIdpGroupMappingDetails Uses

type CreateIdpGroupMappingDetails struct {

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

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

CreateIdpGroupMappingDetails The representation of CreateIdpGroupMappingDetails

func (CreateIdpGroupMappingDetails) String Uses

func (m CreateIdpGroupMappingDetails) String() string

type CreateIdpGroupMappingRequest Uses

type CreateIdpGroupMappingRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateIdpGroupMappingRequest wrapper for the CreateIdpGroupMapping operation

func (CreateIdpGroupMappingRequest) HTTPRequest Uses

func (request CreateIdpGroupMappingRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIdpGroupMappingRequest) RetryPolicy Uses

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

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

func (CreateIdpGroupMappingRequest) String Uses

func (request CreateIdpGroupMappingRequest) String() string

type CreateIdpGroupMappingResponse Uses

type CreateIdpGroupMappingResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateIdpGroupMappingResponse wrapper for the CreateIdpGroupMapping operation

func (CreateIdpGroupMappingResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateIdpGroupMappingResponse) String Uses

func (response CreateIdpGroupMappingResponse) String() string

type CreateMfaTotpDeviceRequest Uses

type CreateMfaTotpDeviceRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateMfaTotpDeviceRequest wrapper for the CreateMfaTotpDevice operation

func (CreateMfaTotpDeviceRequest) HTTPRequest Uses

func (request CreateMfaTotpDeviceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateMfaTotpDeviceRequest) RetryPolicy Uses

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

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

func (CreateMfaTotpDeviceRequest) String Uses

func (request CreateMfaTotpDeviceRequest) String() string

type CreateMfaTotpDeviceResponse Uses

type CreateMfaTotpDeviceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateMfaTotpDeviceResponse wrapper for the CreateMfaTotpDevice operation

func (CreateMfaTotpDeviceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateMfaTotpDeviceResponse) String Uses

func (response CreateMfaTotpDeviceResponse) String() string

type CreateNetworkSourceDetails Uses

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

    // A list of services allowed to make on-behalf-of requests. These requests can have different source IP addresses
    // than those listed in the network source.
    // Currently, only `all` and `none` are supported. The default is `all`.
    Services []string `mandatory:"false" json:"services"`

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

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

CreateNetworkSourceDetails Properties for creating a network source object.

func (CreateNetworkSourceDetails) String Uses

func (m CreateNetworkSourceDetails) String() string

type CreateNetworkSourceRequest Uses

type CreateNetworkSourceRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateNetworkSourceRequest wrapper for the CreateNetworkSource operation

func (CreateNetworkSourceRequest) HTTPRequest Uses

func (request CreateNetworkSourceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateNetworkSourceRequest) RetryPolicy Uses

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

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

func (CreateNetworkSourceRequest) String Uses

func (request CreateNetworkSourceRequest) String() string

type CreateNetworkSourceResponse Uses

type CreateNetworkSourceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateNetworkSourceResponse wrapper for the CreateNetworkSource operation

func (CreateNetworkSourceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateNetworkSourceResponse) String Uses

func (response CreateNetworkSourceResponse) String() string

type CreateOAuth2ClientCredentialDetails Uses

type CreateOAuth2ClientCredentialDetails struct {

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

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

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

CreateOAuth2ClientCredentialDetails The representation of CreateOAuth2ClientCredentialDetails

func (CreateOAuth2ClientCredentialDetails) String Uses

func (m CreateOAuth2ClientCredentialDetails) String() string

type CreateOAuthClientCredentialRequest Uses

type CreateOAuthClientCredentialRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateOAuthClientCredentialRequest wrapper for the CreateOAuthClientCredential operation

func (CreateOAuthClientCredentialRequest) HTTPRequest Uses

func (request CreateOAuthClientCredentialRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOAuthClientCredentialRequest) RetryPolicy Uses

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

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

func (CreateOAuthClientCredentialRequest) String Uses

func (request CreateOAuthClientCredentialRequest) String() string

type CreateOAuthClientCredentialResponse Uses

type CreateOAuthClientCredentialResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateOAuthClientCredentialResponse wrapper for the CreateOAuthClientCredential operation

func (CreateOAuthClientCredentialResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateOAuthClientCredentialResponse) String Uses

func (response CreateOAuthClientCredentialResponse) String() string

type CreateOrResetUIPasswordRequest Uses

type CreateOrResetUIPasswordRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateOrResetUIPasswordRequest wrapper for the CreateOrResetUIPassword operation

func (CreateOrResetUIPasswordRequest) HTTPRequest Uses

func (request CreateOrResetUIPasswordRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOrResetUIPasswordRequest) RetryPolicy Uses

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

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

func (CreateOrResetUIPasswordRequest) String Uses

func (request CreateOrResetUIPasswordRequest) String() string

type CreateOrResetUIPasswordResponse Uses

type CreateOrResetUIPasswordResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateOrResetUIPasswordResponse wrapper for the CreateOrResetUIPassword operation

func (CreateOrResetUIPasswordResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateOrResetUIPasswordResponse) String Uses

func (response CreateOrResetUIPasswordResponse) String() string

type CreatePolicyDetails Uses

type CreatePolicyDetails struct {

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

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

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

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

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

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

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

CreatePolicyDetails The representation of CreatePolicyDetails

func (CreatePolicyDetails) String Uses

func (m CreatePolicyDetails) String() string

type CreatePolicyRequest Uses

type CreatePolicyRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreatePolicyRequest wrapper for the CreatePolicy operation

func (CreatePolicyRequest) HTTPRequest Uses

func (request CreatePolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePolicyRequest) RetryPolicy Uses

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

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

func (CreatePolicyRequest) String Uses

func (request CreatePolicyRequest) String() string

type CreatePolicyResponse Uses

type CreatePolicyResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreatePolicyResponse wrapper for the CreatePolicy operation

func (CreatePolicyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreatePolicyResponse) String Uses

func (response CreatePolicyResponse) String() string

type CreateRegionSubscriptionDetails Uses

type CreateRegionSubscriptionDetails struct {

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

CreateRegionSubscriptionDetails The representation of CreateRegionSubscriptionDetails

func (CreateRegionSubscriptionDetails) String Uses

func (m CreateRegionSubscriptionDetails) String() string

type CreateRegionSubscriptionRequest Uses

type CreateRegionSubscriptionRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateRegionSubscriptionRequest wrapper for the CreateRegionSubscription operation

func (CreateRegionSubscriptionRequest) HTTPRequest Uses

func (request CreateRegionSubscriptionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRegionSubscriptionRequest) RetryPolicy Uses

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

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

func (CreateRegionSubscriptionRequest) String Uses

func (request CreateRegionSubscriptionRequest) String() string

type CreateRegionSubscriptionResponse Uses

type CreateRegionSubscriptionResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateRegionSubscriptionResponse wrapper for the CreateRegionSubscription operation

func (CreateRegionSubscriptionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateRegionSubscriptionResponse) String Uses

func (response CreateRegionSubscriptionResponse) String() string

type CreateSaml2IdentityProviderDetails Uses

type CreateSaml2IdentityProviderDetails struct {

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

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

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

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

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

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

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

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

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

CreateSaml2IdentityProviderDetails The representation of CreateSaml2IdentityProviderDetails

func (CreateSaml2IdentityProviderDetails) GetCompartmentId Uses

func (m CreateSaml2IdentityProviderDetails) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CreateSaml2IdentityProviderDetails) GetDefinedTags Uses

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

GetDefinedTags returns DefinedTags

func (CreateSaml2IdentityProviderDetails) GetDescription Uses

func (m CreateSaml2IdentityProviderDetails) GetDescription() *string

GetDescription returns Description

func (CreateSaml2IdentityProviderDetails) GetFreeformTags Uses

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

GetFreeformTags returns FreeformTags

func (CreateSaml2IdentityProviderDetails) GetName Uses

func (m CreateSaml2IdentityProviderDetails) GetName() *string

GetName returns Name

func (CreateSaml2IdentityProviderDetails) GetProductType Uses

func (m CreateSaml2IdentityProviderDetails) GetProductType() CreateIdentityProviderDetailsProductTypeEnum

GetProductType returns ProductType

func (CreateSaml2IdentityProviderDetails) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (CreateSaml2IdentityProviderDetails) String Uses

func (m CreateSaml2IdentityProviderDetails) String() string

type CreateSmtpCredentialDetails Uses

type CreateSmtpCredentialDetails struct {

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

CreateSmtpCredentialDetails The representation of CreateSmtpCredentialDetails

func (CreateSmtpCredentialDetails) String Uses

func (m CreateSmtpCredentialDetails) String() string

type CreateSmtpCredentialRequest Uses

type CreateSmtpCredentialRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateSmtpCredentialRequest wrapper for the CreateSmtpCredential operation

func (CreateSmtpCredentialRequest) HTTPRequest Uses

func (request CreateSmtpCredentialRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSmtpCredentialRequest) RetryPolicy Uses

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

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

func (CreateSmtpCredentialRequest) String Uses

func (request CreateSmtpCredentialRequest) String() string

type CreateSmtpCredentialResponse Uses

type CreateSmtpCredentialResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateSmtpCredentialResponse wrapper for the CreateSmtpCredential operation

func (CreateSmtpCredentialResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateSmtpCredentialResponse) String Uses

func (response CreateSmtpCredentialResponse) String() string

type CreateSwiftPasswordDetails Uses

type CreateSwiftPasswordDetails struct {

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

CreateSwiftPasswordDetails The representation of CreateSwiftPasswordDetails

func (CreateSwiftPasswordDetails) String Uses

func (m CreateSwiftPasswordDetails) String() string

type CreateSwiftPasswordRequest Uses

type CreateSwiftPasswordRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateSwiftPasswordRequest wrapper for the CreateSwiftPassword operation

func (CreateSwiftPasswordRequest) HTTPRequest Uses

func (request CreateSwiftPasswordRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSwiftPasswordRequest) RetryPolicy Uses

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

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

func (CreateSwiftPasswordRequest) String Uses

func (request CreateSwiftPasswordRequest) String() string

type CreateSwiftPasswordResponse Uses

type CreateSwiftPasswordResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateSwiftPasswordResponse wrapper for the CreateSwiftPassword operation

func (CreateSwiftPasswordResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateSwiftPasswordResponse) String Uses

func (response CreateSwiftPasswordResponse) String() string

type CreateTagDefaultDetails Uses

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

CreateTagDefaultDetails The representation of CreateTagDefaultDetails

func (CreateTagDefaultDetails) String Uses

func (m CreateTagDefaultDetails) String() string

type CreateTagDefaultRequest Uses

type CreateTagDefaultRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateTagDefaultRequest wrapper for the CreateTagDefault operation

func (CreateTagDefaultRequest) HTTPRequest Uses

func (request CreateTagDefaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTagDefaultRequest) RetryPolicy Uses

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

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

func (CreateTagDefaultRequest) String Uses

func (request CreateTagDefaultRequest) String() string

type CreateTagDefaultResponse Uses

type CreateTagDefaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateTagDefaultResponse wrapper for the CreateTagDefault operation

func (CreateTagDefaultResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateTagDefaultResponse) String Uses

func (response CreateTagDefaultResponse) String() string

type CreateTagDetails Uses

type CreateTagDetails struct {

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

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

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

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

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

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

CreateTagDetails The representation of CreateTagDetails

func (CreateTagDetails) String Uses

func (m CreateTagDetails) String() string

func (*CreateTagDetails) UnmarshalJSON Uses

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

UnmarshalJSON unmarshals from json

type CreateTagNamespaceDetails Uses

type CreateTagNamespaceDetails struct {

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

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

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

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

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

CreateTagNamespaceDetails The representation of CreateTagNamespaceDetails

func (CreateTagNamespaceDetails) String Uses

func (m CreateTagNamespaceDetails) String() string

type CreateTagNamespaceRequest Uses

type CreateTagNamespaceRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateTagNamespaceRequest wrapper for the CreateTagNamespace operation

func (CreateTagNamespaceRequest) HTTPRequest Uses

func (request CreateTagNamespaceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTagNamespaceRequest) RetryPolicy Uses

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

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

func (CreateTagNamespaceRequest) String Uses

func (request CreateTagNamespaceRequest) String() string

type CreateTagNamespaceResponse Uses

type CreateTagNamespaceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateTagNamespaceResponse wrapper for the CreateTagNamespace operation

func (CreateTagNamespaceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateTagNamespaceResponse) String Uses

func (response CreateTagNamespaceResponse) String() string

type CreateTagRequest Uses

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateTagRequest wrapper for the CreateTag operation

func (CreateTagRequest) HTTPRequest Uses

func (request CreateTagRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTagRequest) RetryPolicy Uses

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

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

func (CreateTagRequest) String Uses

func (request CreateTagRequest) String() string

type CreateTagResponse Uses

type CreateTagResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateTagResponse wrapper for the CreateTag operation

func (CreateTagResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateTagResponse) String Uses

func (response CreateTagResponse) String() string

type CreateUserDetails Uses

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.
    Description *string `mandatory:"true" json:"description"`

    // The email you assign to the user. Has to be unique across the tenancy.
    Email *string `mandatory:"false" json:"email"`

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

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

CreateUserDetails The representation of CreateUserDetails

func (CreateUserDetails) String Uses

func (m CreateUserDetails) String() string

type CreateUserRequest Uses

type CreateUserRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

CreateUserRequest wrapper for the CreateUser operation

func (CreateUserRequest) HTTPRequest Uses

func (request CreateUserRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateUserRequest) RetryPolicy Uses

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

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

func (CreateUserRequest) String Uses

func (request CreateUserRequest) String() string

type CreateUserResponse Uses

type CreateUserResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

CreateUserResponse wrapper for the CreateUser operation

func (CreateUserResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateUserResponse) String Uses

func (response CreateUserResponse) String() string

type CustomerSecretKey Uses

type CustomerSecretKey struct {

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

    // 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 display name you assign to the secret key. Does not have to be unique, and it's changeable.
    DisplayName *string `mandatory:"false" json:"displayName"`

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

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

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

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

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

func (CustomerSecretKey) String Uses

func (m CustomerSecretKey) String() string

type CustomerSecretKeyLifecycleStateEnum Uses

type CustomerSecretKeyLifecycleStateEnum string

CustomerSecretKeyLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CustomerSecretKeyLifecycleStateEnum

func GetCustomerSecretKeyLifecycleStateEnumValues Uses

func GetCustomerSecretKeyLifecycleStateEnumValues() []CustomerSecretKeyLifecycleStateEnum

GetCustomerSecretKeyLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeyLifecycleStateEnum

type CustomerSecretKeySummary Uses

type CustomerSecretKeySummary struct {

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

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

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

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

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

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

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

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

func (CustomerSecretKeySummary) String Uses

func (m CustomerSecretKeySummary) String() string

type CustomerSecretKeySummaryLifecycleStateEnum Uses

type CustomerSecretKeySummaryLifecycleStateEnum string

CustomerSecretKeySummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CustomerSecretKeySummaryLifecycleStateEnum

func GetCustomerSecretKeySummaryLifecycleStateEnumValues Uses

func GetCustomerSecretKeySummaryLifecycleStateEnumValues() []CustomerSecretKeySummaryLifecycleStateEnum

GetCustomerSecretKeySummaryLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeySummaryLifecycleStateEnum

type DefaultTagDefinitionValidator Uses

type DefaultTagDefinitionValidator struct {
}

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

func (DefaultTagDefinitionValidator) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (DefaultTagDefinitionValidator) String Uses

func (m DefaultTagDefinitionValidator) String() string

type DeleteApiKeyRequest Uses

type DeleteApiKeyRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteApiKeyRequest wrapper for the DeleteApiKey operation

func (DeleteApiKeyRequest) HTTPRequest Uses

func (request DeleteApiKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteApiKeyRequest) RetryPolicy Uses

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

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

func (DeleteApiKeyRequest) String Uses

func (request DeleteApiKeyRequest) String() string

type DeleteApiKeyResponse Uses

type DeleteApiKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteApiKeyResponse wrapper for the DeleteApiKey operation

func (DeleteApiKeyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteApiKeyResponse) String Uses

func (response DeleteApiKeyResponse) String() string

type DeleteAuthTokenRequest Uses

type DeleteAuthTokenRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteAuthTokenRequest wrapper for the DeleteAuthToken operation

func (DeleteAuthTokenRequest) HTTPRequest Uses

func (request DeleteAuthTokenRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAuthTokenRequest) RetryPolicy Uses

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

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

func (DeleteAuthTokenRequest) String Uses

func (request DeleteAuthTokenRequest) String() string

type DeleteAuthTokenResponse Uses

type DeleteAuthTokenResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteAuthTokenResponse wrapper for the DeleteAuthToken operation

func (DeleteAuthTokenResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteAuthTokenResponse) String Uses

func (response DeleteAuthTokenResponse) String() string

type DeleteCompartmentRequest Uses

type DeleteCompartmentRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteCompartmentRequest wrapper for the DeleteCompartment operation

func (DeleteCompartmentRequest) HTTPRequest Uses

func (request DeleteCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCompartmentRequest) RetryPolicy Uses

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

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

func (DeleteCompartmentRequest) String Uses

func (request DeleteCompartmentRequest) String() string

type DeleteCompartmentResponse Uses

type DeleteCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

DeleteCompartmentResponse wrapper for the DeleteCompartment operation

func (DeleteCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteCompartmentResponse) String Uses

func (response DeleteCompartmentResponse) String() string

type DeleteCustomerSecretKeyRequest Uses

type DeleteCustomerSecretKeyRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteCustomerSecretKeyRequest wrapper for the DeleteCustomerSecretKey operation

func (DeleteCustomerSecretKeyRequest) HTTPRequest Uses

func (request DeleteCustomerSecretKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCustomerSecretKeyRequest) RetryPolicy Uses

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

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

func (DeleteCustomerSecretKeyRequest) String Uses

func (request DeleteCustomerSecretKeyRequest) String() string

type DeleteCustomerSecretKeyResponse Uses

type DeleteCustomerSecretKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteCustomerSecretKeyResponse wrapper for the DeleteCustomerSecretKey operation

func (DeleteCustomerSecretKeyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteCustomerSecretKeyResponse) String Uses

func (response DeleteCustomerSecretKeyResponse) String() string

type DeleteDynamicGroupRequest Uses

type DeleteDynamicGroupRequest struct {

    // The OCID of the dynamic group.
    DynamicGroupId *string `mandatory:"true" contributesTo:"path" name:"dynamicGroupId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteDynamicGroupRequest wrapper for the DeleteDynamicGroup operation

func (DeleteDynamicGroupRequest) HTTPRequest Uses

func (request DeleteDynamicGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDynamicGroupRequest) RetryPolicy Uses

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

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

func (DeleteDynamicGroupRequest) String Uses

func (request DeleteDynamicGroupRequest) String() string

type DeleteDynamicGroupResponse Uses

type DeleteDynamicGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteDynamicGroupResponse wrapper for the DeleteDynamicGroup operation

func (DeleteDynamicGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteDynamicGroupResponse) String Uses

func (response DeleteDynamicGroupResponse) String() string

type DeleteGroupRequest Uses

type DeleteGroupRequest struct {

    // The OCID of the group.
    GroupId *string `mandatory:"true" contributesTo:"path" name:"groupId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteGroupRequest wrapper for the DeleteGroup operation

func (DeleteGroupRequest) HTTPRequest Uses

func (request DeleteGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteGroupRequest) RetryPolicy Uses

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

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

func (DeleteGroupRequest) String Uses

func (request DeleteGroupRequest) String() string

type DeleteGroupResponse Uses

type DeleteGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteGroupResponse wrapper for the DeleteGroup operation

func (DeleteGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteGroupResponse) String Uses

func (response DeleteGroupResponse) String() string

type DeleteIdentityProviderRequest Uses

type DeleteIdentityProviderRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteIdentityProviderRequest wrapper for the DeleteIdentityProvider operation

func (DeleteIdentityProviderRequest) HTTPRequest Uses

func (request DeleteIdentityProviderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIdentityProviderRequest) RetryPolicy Uses

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

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

func (DeleteIdentityProviderRequest) String Uses

func (request DeleteIdentityProviderRequest) String() string

type DeleteIdentityProviderResponse Uses

type DeleteIdentityProviderResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteIdentityProviderResponse wrapper for the DeleteIdentityProvider operation

func (DeleteIdentityProviderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteIdentityProviderResponse) String Uses

func (response DeleteIdentityProviderResponse) String() string

type DeleteIdpGroupMappingRequest Uses

type DeleteIdpGroupMappingRequest struct {

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

    // The OCID of the group mapping.
    MappingId *string `mandatory:"true" contributesTo:"path" name:"mappingId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteIdpGroupMappingRequest wrapper for the DeleteIdpGroupMapping operation

func (DeleteIdpGroupMappingRequest) HTTPRequest Uses

func (request DeleteIdpGroupMappingRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIdpGroupMappingRequest) RetryPolicy Uses

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

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

func (DeleteIdpGroupMappingRequest) String Uses

func (request DeleteIdpGroupMappingRequest) String() string

type DeleteIdpGroupMappingResponse Uses

type DeleteIdpGroupMappingResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteIdpGroupMappingResponse wrapper for the DeleteIdpGroupMapping operation

func (DeleteIdpGroupMappingResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteIdpGroupMappingResponse) String Uses

func (response DeleteIdpGroupMappingResponse) String() string

type DeleteMfaTotpDeviceRequest Uses

type DeleteMfaTotpDeviceRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteMfaTotpDeviceRequest wrapper for the DeleteMfaTotpDevice operation

func (DeleteMfaTotpDeviceRequest) HTTPRequest Uses

func (request DeleteMfaTotpDeviceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteMfaTotpDeviceRequest) RetryPolicy Uses

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

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

func (DeleteMfaTotpDeviceRequest) String Uses

func (request DeleteMfaTotpDeviceRequest) String() string

type DeleteMfaTotpDeviceResponse Uses

type DeleteMfaTotpDeviceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteMfaTotpDeviceResponse wrapper for the DeleteMfaTotpDevice operation

func (DeleteMfaTotpDeviceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteMfaTotpDeviceResponse) String Uses

func (response DeleteMfaTotpDeviceResponse) String() string

type DeleteNetworkSourceRequest Uses

type DeleteNetworkSourceRequest struct {

    // The OCID of the network source.
    NetworkSourceId *string `mandatory:"true" contributesTo:"path" name:"networkSourceId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteNetworkSourceRequest wrapper for the DeleteNetworkSource operation

func (DeleteNetworkSourceRequest) HTTPRequest Uses

func (request DeleteNetworkSourceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteNetworkSourceRequest) RetryPolicy Uses

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

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

func (DeleteNetworkSourceRequest) String Uses

func (request DeleteNetworkSourceRequest) String() string

type DeleteNetworkSourceResponse Uses

type DeleteNetworkSourceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteNetworkSourceResponse wrapper for the DeleteNetworkSource operation

func (DeleteNetworkSourceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteNetworkSourceResponse) String Uses

func (response DeleteNetworkSourceResponse) String() string

type DeleteOAuthClientCredentialRequest Uses

type DeleteOAuthClientCredentialRequest struct {

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

    // The ID of the Oauth credential.
    Oauth2ClientCredentialId *string `mandatory:"true" contributesTo:"path" name:"oauth2ClientCredentialId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteOAuthClientCredentialRequest wrapper for the DeleteOAuthClientCredential operation

func (DeleteOAuthClientCredentialRequest) HTTPRequest Uses

func (request DeleteOAuthClientCredentialRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOAuthClientCredentialRequest) RetryPolicy Uses

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

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

func (DeleteOAuthClientCredentialRequest) String Uses

func (request DeleteOAuthClientCredentialRequest) String() string

type DeleteOAuthClientCredentialResponse Uses

type DeleteOAuthClientCredentialResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteOAuthClientCredentialResponse wrapper for the DeleteOAuthClientCredential operation

func (DeleteOAuthClientCredentialResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteOAuthClientCredentialResponse) String Uses

func (response DeleteOAuthClientCredentialResponse) String() string

type DeletePolicyRequest Uses

type DeletePolicyRequest struct {

    // The OCID of the policy.
    PolicyId *string `mandatory:"true" contributesTo:"path" name:"policyId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeletePolicyRequest wrapper for the DeletePolicy operation

func (DeletePolicyRequest) HTTPRequest Uses

func (request DeletePolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePolicyRequest) RetryPolicy Uses

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

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

func (DeletePolicyRequest) String Uses

func (request DeletePolicyRequest) String() string

type DeletePolicyResponse Uses

type DeletePolicyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeletePolicyResponse wrapper for the DeletePolicy operation

func (DeletePolicyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeletePolicyResponse) String Uses

func (response DeletePolicyResponse) String() string

type DeleteSmtpCredentialRequest Uses

type DeleteSmtpCredentialRequest struct {

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

    // The OCID of the SMTP credential.
    SmtpCredentialId *string `mandatory:"true" contributesTo:"path" name:"smtpCredentialId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteSmtpCredentialRequest wrapper for the DeleteSmtpCredential operation

func (DeleteSmtpCredentialRequest) HTTPRequest Uses

func (request DeleteSmtpCredentialRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSmtpCredentialRequest) RetryPolicy Uses

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

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

func (DeleteSmtpCredentialRequest) String Uses

func (request DeleteSmtpCredentialRequest) String() string

type DeleteSmtpCredentialResponse Uses

type DeleteSmtpCredentialResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteSmtpCredentialResponse wrapper for the DeleteSmtpCredential operation

func (DeleteSmtpCredentialResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteSmtpCredentialResponse) String Uses

func (response DeleteSmtpCredentialResponse) String() string

type DeleteSwiftPasswordRequest Uses

type DeleteSwiftPasswordRequest struct {

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

    // The OCID of the Swift password.
    SwiftPasswordId *string `mandatory:"true" contributesTo:"path" name:"swiftPasswordId"`

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteSwiftPasswordRequest wrapper for the DeleteSwiftPassword operation

func (DeleteSwiftPasswordRequest) HTTPRequest Uses

func (request DeleteSwiftPasswordRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSwiftPasswordRequest) RetryPolicy Uses

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

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

func (DeleteSwiftPasswordRequest) String Uses

func (request DeleteSwiftPasswordRequest) String() string

type DeleteSwiftPasswordResponse Uses

type DeleteSwiftPasswordResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteSwiftPasswordResponse wrapper for the DeleteSwiftPassword operation

func (DeleteSwiftPasswordResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteSwiftPasswordResponse) String Uses

func (response DeleteSwiftPasswordResponse) String() string

type DeleteTagDefaultRequest Uses

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

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteTagDefaultRequest wrapper for the DeleteTagDefault operation

func (DeleteTagDefaultRequest) HTTPRequest Uses

func (request DeleteTagDefaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTagDefaultRequest) RetryPolicy Uses

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

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

func (DeleteTagDefaultRequest) String Uses

func (request DeleteTagDefaultRequest) String() string

type DeleteTagDefaultResponse Uses

type DeleteTagDefaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteTagDefaultResponse wrapper for the DeleteTagDefault operation

func (DeleteTagDefaultResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteTagDefaultResponse) String Uses

func (response DeleteTagDefaultResponse) String() string

type DeleteTagNamespaceRequest Uses

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

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteTagNamespaceRequest wrapper for the DeleteTagNamespace operation

func (DeleteTagNamespaceRequest) HTTPRequest Uses

func (request DeleteTagNamespaceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTagNamespaceRequest) RetryPolicy Uses

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

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

func (DeleteTagNamespaceRequest) String Uses

func (request DeleteTagNamespaceRequest) String() string

type DeleteTagNamespaceResponse Uses

type DeleteTagNamespaceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteTagNamespaceResponse wrapper for the DeleteTagNamespace operation

func (DeleteTagNamespaceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteTagNamespaceResponse) String Uses

func (response DeleteTagNamespaceResponse) String() string

type DeleteTagRequest Uses

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteTagRequest wrapper for the DeleteTag operation

func (DeleteTagRequest) HTTPRequest Uses

func (request DeleteTagRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTagRequest) RetryPolicy Uses

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

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

func (DeleteTagRequest) String Uses

func (request DeleteTagRequest) String() string

type DeleteTagResponse Uses

type DeleteTagResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

DeleteTagResponse wrapper for the DeleteTag operation

func (DeleteTagResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteTagResponse) String Uses

func (response DeleteTagResponse) String() string

type DeleteUserRequest Uses

type DeleteUserRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

DeleteUserRequest wrapper for the DeleteUser operation

func (DeleteUserRequest) HTTPRequest Uses

func (request DeleteUserRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteUserRequest) RetryPolicy Uses

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

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

func (DeleteUserRequest) String Uses

func (request DeleteUserRequest) String() string

type DeleteUserResponse Uses

type DeleteUserResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteUserResponse wrapper for the DeleteUser operation

func (DeleteUserResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteUserResponse) String Uses

func (response DeleteUserResponse) String() string

type DynamicGroup Uses

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.
    Description *string `mandatory:"true" json:"description"`

    // A rule string that defines which instance certificates will be matched.
    // For syntax, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingdynamicgroups.htm).
    MatchingRule *string `mandatory:"true" json:"matchingRule"`

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

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

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

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

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

DynamicGroup A dynamic group defines a matching rule. Every bare metal or virtual machine instance is deployed with an instance certificate. The certificate contains metadata about the instance. This includes the instance OCID and the compartment OCID, along with a few other optional properties. When an API call is made using this instance certificate as the authenticator, the certificate can be matched to one or multiple dynamic groups. The instance can then get access to the API based on the permissions granted in policies written for the dynamic groups. This works like regular user/group membership. But in that case, the membership is a static relationship, whereas in a dynamic group, the membership of an instance certificate to a dynamic group is determined during runtime. For more information, see Managing Dynamic Groups (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingdynamicgroups.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (DynamicGroup) String Uses

func (m DynamicGroup) String() string

type DynamicGroupLifecycleStateEnum Uses

type DynamicGroupLifecycleStateEnum string

DynamicGroupLifecycleStateEnum Enum with underlying type: string

const (
    DynamicGroupLifecycleStateCreating DynamicGroupLifecycleStateEnum = "CREATING"
    DynamicGroupLifecycleStateActive   DynamicGroupLifecycleStateEnum = "ACTIVE"
    DynamicGroupLifecycleStateInactive DynamicGroupLifecycleStateEnum = "INACTIVE"
    DynamicGroupLifecycleStateDeleting DynamicGroupLifecycleStateEnum = "DELETING"
    DynamicGroupLifecycleStateDeleted  DynamicGroupLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for DynamicGroupLifecycleStateEnum

func GetDynamicGroupLifecycleStateEnumValues Uses

func GetDynamicGroupLifecycleStateEnumValues() []DynamicGroupLifecycleStateEnum

GetDynamicGroupLifecycleStateEnumValues Enumerates the set of values for DynamicGroupLifecycleStateEnum

type EnumTagDefinitionValidator Uses

type EnumTagDefinitionValidator struct {

    // The list of allowed values for a definedTag value.
    Values []string `mandatory:"false" json:"values"`
}

EnumTagDefinitionValidator Used to validate the value set for a defined tag and contains the list of allowable `values`. You must specify at least one valid value in the `values` array. You can't have blank or or empty strings (`""`). Duplicate values are not allowed.

func (EnumTagDefinitionValidator) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (EnumTagDefinitionValidator) String Uses

func (m EnumTagDefinitionValidator) String() string

type FaultDomain Uses

type FaultDomain struct {

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

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

    // The OCID of the compartment. Currently only tenancy (root) compartment can be provided.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // The name of the availabilityDomain where the Fault Domain belongs.
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
}

FaultDomain A Fault Domain is a logical grouping of hardware and infrastructure within an Availability Domain that can become unavailable in its entirety either due to hardware failure such as Top-of-rack (TOR) switch failure or due to planned software maintenance such as security updates that reboot your instances.

func (FaultDomain) String Uses

func (m FaultDomain) String() string

type FullyQualifiedScope Uses

type FullyQualifiedScope struct {

    // Audience for the given scope context.
    Audience *string `mandatory:"true" json:"audience"`

    // Allowed permission scope for the given context.
    Scope *string `mandatory:"true" json:"scope"`
}

FullyQualifiedScope The representation of FullyQualifiedScope

func (FullyQualifiedScope) String Uses

func (m FullyQualifiedScope) String() string

type GenerateTotpSeedRequest Uses

type GenerateTotpSeedRequest struct {

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

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GenerateTotpSeedRequest wrapper for the GenerateTotpSeed operation

func (GenerateTotpSeedRequest) HTTPRequest Uses

func (request GenerateTotpSeedRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GenerateTotpSeedRequest) RetryPolicy Uses

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

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

func (GenerateTotpSeedRequest) String Uses

func (request GenerateTotpSeedRequest) String() string

type GenerateTotpSeedResponse Uses

type GenerateTotpSeedResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GenerateTotpSeedResponse wrapper for the GenerateTotpSeed operation

func (GenerateTotpSeedResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GenerateTotpSeedResponse) String Uses

func (response GenerateTotpSeedResponse) String() string

type GetAuthenticationPolicyRequest Uses

type GetAuthenticationPolicyRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetAuthenticationPolicyRequest wrapper for the GetAuthenticationPolicy operation

func (GetAuthenticationPolicyRequest) HTTPRequest Uses

func (request GetAuthenticationPolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAuthenticationPolicyRequest) RetryPolicy Uses

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

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

func (GetAuthenticationPolicyRequest) String Uses

func (request GetAuthenticationPolicyRequest) String() string

type GetAuthenticationPolicyResponse Uses

type GetAuthenticationPolicyResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetAuthenticationPolicyResponse wrapper for the GetAuthenticationPolicy operation

func (GetAuthenticationPolicyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetAuthenticationPolicyResponse) String Uses

func (response GetAuthenticationPolicyResponse) String() string

type GetCompartmentRequest Uses

type GetCompartmentRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetCompartmentRequest wrapper for the GetCompartment operation

func (GetCompartmentRequest) HTTPRequest Uses

func (request GetCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCompartmentRequest) RetryPolicy Uses

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

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

func (GetCompartmentRequest) String Uses

func (request GetCompartmentRequest) String() string

type GetCompartmentResponse Uses

type GetCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetCompartmentResponse wrapper for the GetCompartment operation

func (GetCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetCompartmentResponse) String Uses

func (response GetCompartmentResponse) String() string

type GetDynamicGroupRequest Uses

type GetDynamicGroupRequest struct {

    // The OCID of the dynamic group.
    DynamicGroupId *string `mandatory:"true" contributesTo:"path" name:"dynamicGroupId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetDynamicGroupRequest wrapper for the GetDynamicGroup operation

func (GetDynamicGroupRequest) HTTPRequest Uses

func (request GetDynamicGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDynamicGroupRequest) RetryPolicy Uses

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

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

func (GetDynamicGroupRequest) String Uses

func (request GetDynamicGroupRequest) String() string

type GetDynamicGroupResponse Uses

type GetDynamicGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetDynamicGroupResponse wrapper for the GetDynamicGroup operation

func (GetDynamicGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetDynamicGroupResponse) String Uses

func (response GetDynamicGroupResponse) String() string

type GetGroupRequest Uses

type GetGroupRequest struct {

    // The OCID of the group.
    GroupId *string `mandatory:"true" contributesTo:"path" name:"groupId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetGroupRequest wrapper for the GetGroup operation

func (GetGroupRequest) HTTPRequest Uses

func (request GetGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetGroupRequest) RetryPolicy Uses

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

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

func (GetGroupRequest) String Uses

func (request GetGroupRequest) String() string

type GetGroupResponse Uses

type GetGroupResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetGroupResponse wrapper for the GetGroup operation

func (GetGroupResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetGroupResponse) String Uses

func (response GetGroupResponse) String() string

type GetIdentityProviderRequest Uses

type GetIdentityProviderRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetIdentityProviderRequest wrapper for the GetIdentityProvider operation

func (GetIdentityProviderRequest) HTTPRequest Uses

func (request GetIdentityProviderRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIdentityProviderRequest) RetryPolicy Uses

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

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

func (GetIdentityProviderRequest) String Uses

func (request GetIdentityProviderRequest) String() string

type GetIdentityProviderResponse Uses

type GetIdentityProviderResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetIdentityProviderResponse wrapper for the GetIdentityProvider operation

func (GetIdentityProviderResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetIdentityProviderResponse) String Uses

func (response GetIdentityProviderResponse) String() string

type GetIdpGroupMappingRequest Uses

type GetIdpGroupMappingRequest struct {

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

    // The OCID of the group mapping.
    MappingId *string `mandatory:"true" contributesTo:"path" name:"mappingId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetIdpGroupMappingRequest wrapper for the GetIdpGroupMapping operation

func (GetIdpGroupMappingRequest) HTTPRequest Uses

func (request GetIdpGroupMappingRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIdpGroupMappingRequest) RetryPolicy Uses

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

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

func (GetIdpGroupMappingRequest) String Uses

func (request GetIdpGroupMappingRequest) String() string

type GetIdpGroupMappingResponse Uses

type GetIdpGroupMappingResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetIdpGroupMappingResponse wrapper for the GetIdpGroupMapping operation

func (GetIdpGroupMappingResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetIdpGroupMappingResponse) String Uses

func (response GetIdpGroupMappingResponse) String() string

type GetMfaTotpDeviceRequest Uses

type GetMfaTotpDeviceRequest struct {

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

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetMfaTotpDeviceRequest wrapper for the GetMfaTotpDevice operation

func (GetMfaTotpDeviceRequest) HTTPRequest Uses

func (request GetMfaTotpDeviceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetMfaTotpDeviceRequest) RetryPolicy Uses

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

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

func (GetMfaTotpDeviceRequest) String Uses

func (request GetMfaTotpDeviceRequest) String() string

type GetMfaTotpDeviceResponse Uses

type GetMfaTotpDeviceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetMfaTotpDeviceResponse wrapper for the GetMfaTotpDevice operation

func (GetMfaTotpDeviceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetMfaTotpDeviceResponse) String Uses

func (response GetMfaTotpDeviceResponse) String() string

type GetNetworkSourceRequest Uses

type GetNetworkSourceRequest struct {

    // The OCID of the network source.
    NetworkSourceId *string `mandatory:"true" contributesTo:"path" name:"networkSourceId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetNetworkSourceRequest wrapper for the GetNetworkSource operation

func (GetNetworkSourceRequest) HTTPRequest Uses

func (request GetNetworkSourceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNetworkSourceRequest) RetryPolicy Uses

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

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

func (GetNetworkSourceRequest) String Uses

func (request GetNetworkSourceRequest) String() string

type GetNetworkSourceResponse Uses

type GetNetworkSourceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetNetworkSourceResponse wrapper for the GetNetworkSource operation

func (GetNetworkSourceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetNetworkSourceResponse) String Uses

func (response GetNetworkSourceResponse) String() string

type GetPolicyRequest Uses

type GetPolicyRequest struct {

    // The OCID of the policy.
    PolicyId *string `mandatory:"true" contributesTo:"path" name:"policyId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetPolicyRequest wrapper for the GetPolicy operation

func (GetPolicyRequest) HTTPRequest Uses

func (request GetPolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPolicyRequest) RetryPolicy Uses

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

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

func (GetPolicyRequest) String Uses

func (request GetPolicyRequest) String() string

type GetPolicyResponse Uses

type GetPolicyResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetPolicyResponse wrapper for the GetPolicy operation

func (GetPolicyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetPolicyResponse) String Uses

func (response GetPolicyResponse) String() string

type GetTagDefaultRequest Uses

type GetTagDefaultRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetTagDefaultRequest wrapper for the GetTagDefault operation

func (GetTagDefaultRequest) HTTPRequest Uses

func (request GetTagDefaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTagDefaultRequest) RetryPolicy Uses

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

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

func (GetTagDefaultRequest) String Uses

func (request GetTagDefaultRequest) String() string

type GetTagDefaultResponse Uses

type GetTagDefaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetTagDefaultResponse wrapper for the GetTagDefault operation

func (GetTagDefaultResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetTagDefaultResponse) String Uses

func (response GetTagDefaultResponse) String() string

type GetTagNamespaceRequest Uses

type GetTagNamespaceRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetTagNamespaceRequest wrapper for the GetTagNamespace operation

func (GetTagNamespaceRequest) HTTPRequest Uses

func (request GetTagNamespaceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTagNamespaceRequest) RetryPolicy Uses

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

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

func (GetTagNamespaceRequest) String Uses

func (request GetTagNamespaceRequest) String() string

type GetTagNamespaceResponse Uses

type GetTagNamespaceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetTagNamespaceResponse wrapper for the GetTagNamespace operation

func (GetTagNamespaceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetTagNamespaceResponse) String Uses

func (response GetTagNamespaceResponse) String() string

type GetTagRequest Uses

type GetTagRequest struct {

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

    // The name of the tag.
    TagName *string `mandatory:"true" contributesTo:"path" name:"tagName"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetTagRequest wrapper for the GetTag operation

func (GetTagRequest) HTTPRequest Uses

func (request GetTagRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTagRequest) RetryPolicy Uses

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

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

func (GetTagRequest) String Uses

func (request GetTagRequest) String() string

type GetTagResponse Uses

type GetTagResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetTagResponse wrapper for the GetTag operation

func (GetTagResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetTagResponse) String Uses

func (response GetTagResponse) String() string

type GetTaggingWorkRequestRequest Uses

type GetTaggingWorkRequestRequest struct {

    // The OCID of the work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetTaggingWorkRequestRequest wrapper for the GetTaggingWorkRequest operation

func (GetTaggingWorkRequestRequest) HTTPRequest Uses

func (request GetTaggingWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTaggingWorkRequestRequest) RetryPolicy Uses

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

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

func (GetTaggingWorkRequestRequest) String Uses

func (request GetTaggingWorkRequestRequest) String() string

type GetTaggingWorkRequestResponse Uses

type GetTaggingWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // The number of seconds that the client should wait before polling again.
    RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

GetTaggingWorkRequestResponse wrapper for the GetTaggingWorkRequest operation

func (GetTaggingWorkRequestResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetTaggingWorkRequestResponse) String Uses

func (response GetTaggingWorkRequestResponse) String() string

type GetTenancyRequest Uses

type GetTenancyRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetTenancyRequest wrapper for the GetTenancy operation

func (GetTenancyRequest) HTTPRequest Uses

func (request GetTenancyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTenancyRequest) RetryPolicy Uses

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

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

func (GetTenancyRequest) String Uses

func (request GetTenancyRequest) String() string

type GetTenancyResponse Uses

type GetTenancyResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetTenancyResponse wrapper for the GetTenancy operation

func (GetTenancyResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetTenancyResponse) String Uses

func (response GetTenancyResponse) String() string

type GetUserGroupMembershipRequest Uses

type GetUserGroupMembershipRequest struct {

    // The OCID of the userGroupMembership.
    UserGroupMembershipId *string `mandatory:"true" contributesTo:"path" name:"userGroupMembershipId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetUserGroupMembershipRequest wrapper for the GetUserGroupMembership operation

func (GetUserGroupMembershipRequest) HTTPRequest Uses

func (request GetUserGroupMembershipRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUserGroupMembershipRequest) RetryPolicy Uses

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

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

func (GetUserGroupMembershipRequest) String Uses

func (request GetUserGroupMembershipRequest) String() string

type GetUserGroupMembershipResponse Uses

type GetUserGroupMembershipResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetUserGroupMembershipResponse wrapper for the GetUserGroupMembership operation

func (GetUserGroupMembershipResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetUserGroupMembershipResponse) String Uses

func (response GetUserGroupMembershipResponse) String() string

type GetUserRequest Uses

type GetUserRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetUserRequest wrapper for the GetUser operation

func (GetUserRequest) HTTPRequest Uses

func (request GetUserRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUserRequest) RetryPolicy Uses

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

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

func (GetUserRequest) String Uses

func (request GetUserRequest) String() string

type GetUserResponse Uses

type GetUserResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetUserResponse wrapper for the GetUser operation

func (GetUserResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetUserResponse) String Uses

func (response GetUserResponse) String() string

type GetUserUIPasswordInformationRequest Uses

type GetUserUIPasswordInformationRequest struct {

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

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetUserUIPasswordInformationRequest wrapper for the GetUserUIPasswordInformation operation

func (GetUserUIPasswordInformationRequest) HTTPRequest Uses

func (request GetUserUIPasswordInformationRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUserUIPasswordInformationRequest) RetryPolicy Uses

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

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

func (GetUserUIPasswordInformationRequest) String Uses

func (request GetUserUIPasswordInformationRequest) String() string

type GetUserUIPasswordInformationResponse Uses

type GetUserUIPasswordInformationResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

GetUserUIPasswordInformationResponse wrapper for the GetUserUIPasswordInformation operation

func (GetUserUIPasswordInformationResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetUserUIPasswordInformationResponse) String Uses

func (response GetUserUIPasswordInformationResponse) String() string

type GetWorkRequestRequest Uses

type GetWorkRequestRequest struct {

    // The OCID of the work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest Uses

func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy Uses

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

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

func (GetWorkRequestRequest) String Uses

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse Uses

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // The number of seconds that the client should wait before polling again.
    RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String Uses

func (response GetWorkRequestResponse) String() string

type Group Uses

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.
    Description *string `mandatory:"true" json:"description"`

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

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

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

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

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

Group A collection of users who all need the same type of access to a particular set of resources or compartment. For conceptual information about groups and other IAM Service components, see Overview of the IAM Service (https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm). If you're federating with an identity provider (IdP), you need to create mappings between the groups defined in the IdP and groups you define in the IAM service. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). Also see IdentityProvider and IdpGroupMapping. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Group) String Uses

func (m Group) String() string

type GroupLifecycleStateEnum Uses

type GroupLifecycleStateEnum string

GroupLifecycleStateEnum Enum with underlying type: string

const (
    GroupLifecycleStateCreating GroupLifecycleStateEnum = "CREATING"
    GroupLifecycleStateActive   GroupLifecycleStateEnum = "ACTIVE"
    GroupLifecycleStateInactive GroupLifecycleStateEnum = "INACTIVE"
    GroupLifecycleStateDeleting GroupLifecycleStateEnum = "DELETING"
    GroupLifecycleStateDeleted  GroupLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for GroupLifecycleStateEnum

func GetGroupLifecycleStateEnumValues Uses

func GetGroupLifecycleStateEnumValues() []GroupLifecycleStateEnum

GetGroupLifecycleStateEnumValues Enumerates the set of values for GroupLifecycleStateEnum

type IdentityClient Uses

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

IdentityClient a client for Identity

func NewIdentityClientWithConfigurationProvider Uses

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 Uses

func NewIdentityClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client IdentityClient, err error)

NewIdentityClientWithOboToken Creates a new default Identity client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (IdentityClient) ActivateMfaTotpDevice Uses

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.

func (IdentityClient) AddUserToGroup Uses

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.

func (IdentityClient) AssembleEffectiveTagSet Uses

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.

func (IdentityClient) BulkDeleteResources Uses

func (client IdentityClient) BulkDeleteResources(ctx context.Context, request BulkDeleteResourcesRequest) (response BulkDeleteResourcesResponse, err error)

BulkDeleteResources Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate permissions to delete the resources in the request. This API can only be invoked from the tenancy's home region (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingregions.htm#Home). This operation creates a WorkRequest. Use the GetWorkRequest API to monitor the status of the bulk action.

func (IdentityClient) BulkDeleteTags Uses

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 following actions happen immediately:

* If the tag is a cost-tracking tag, the tag no longer counts against your
10 cost-tracking tags limit, even if you do not disable the tag before running this operation.
* If the tag is used with dynamic groups, the rules that contain the tag are no longer
evaluated against the tag.

After you start this operation, the state of the tag changes to DELETING, and tag removal from resources begins. This process can take up to 48 hours depending on the number of resources that are tagged and the regions in which those resources reside. When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state changes to DELETED, you can use the same tag name again. After you start this operation, you cannot start either the DeleteTag or the CascadeDeleteTagNamespace operation until this process completes. In order to delete tags, you must first retire the tags. Use UpdateTag to retire a tag.

func (IdentityClient) BulkMoveResources Uses

func (client IdentityClient) BulkMoveResources(ctx context.Context, request BulkMoveResourcesRequest) (response BulkMoveResourcesResponse, err error)

BulkMoveResources Moves multiple resources from one compartment to another. All resources must be in the same compartment. This API can only be invoked from the tenancy's home region (https://docs.cloud.oracle.com/Content/Identity/Tasks/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.

func (IdentityClient) CascadeDeleteTagNamespace Uses

func (client IdentityClient) CascadeDeleteTagNamespace(ctx context.Context, request CascadeDeleteTagNamespaceRequest) (response CascadeDeleteTagNamespaceResponse, err error)

CascadeDeleteTagNamespace Deletes the specified tag namespace. This operation triggers a process that removes all of the tags defined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace. After you start the delete operation:

* New tag key definitions cannot be created under the namespace.
* The state of the tag namespace changes to DELETING.
* Tag removal from the resources begins.

This process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources that are tagged, and the locations of the regions in which those resources reside. After all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace changes its state to DELETED, you can use the name of the deleted tag namespace again. After you start this operation, you cannot start either the DeleteTag or the BulkDeleteTags operation until this process completes. To delete a tag namespace, you must first retire it. Use UpdateTagNamespace to retire a tag namespace.

func (IdentityClient) ChangeTagNamespaceCompartment Uses

func (client IdentityClient) ChangeTagNamespaceCompartment(ctx context.Context, request ChangeTagNamespaceCompartmentRequest) (response ChangeTagNamespaceCompartmentResponse, err error)

ChangeTagNamespaceCompartment Moves the specified tag namespace to the specified compartment within the same tenancy. To move the tag namespace, you must have the manage tag-namespaces permission on both compartments. For more information about IAM policies, see Details for IAM (https://docs.cloud.oracle.com/Content/Identity/Reference/iampolicyreference.htm). Moving a tag namespace moves all the tag key definitions contained in the tag namespace.

func (*IdentityClient) ConfigurationProvider Uses

func (client *IdentityClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (IdentityClient) CreateAuthToken Uses

func (client IdentityClient) CreateAuthToken(ctx context.Context, request CreateAuthTokenRequest) (response CreateAuthTokenResponse, err error)

CreateAuthToken Creates a new auth token for the specified user. For information about what auth tokens are for, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.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.

func (IdentityClient) CreateCompartment Uses

func (client IdentityClient) CreateCompartment(ctx context.Context, request CreateCompartmentRequest) (response CreateCompartmentResponse, err error)

CreateCompartment Creates a new compartment in the specified compartment. **Important:** Compartments cannot be deleted. Specify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the compartment, which must be unique across all compartments in your tenancy. You can use this name or the OCID when writing policies that apply to the compartment. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/Concepts/policies.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.

func (IdentityClient) CreateCustomerSecretKey Uses

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. For information, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.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.

func (IdentityClient) CreateDynamicGroup Uses

func (client IdentityClient) CreateDynamicGroup(ctx context.Context, request CreateDynamicGroupRequest) (response CreateDynamicGroupResponse, err error)

CreateDynamicGroup Creates a new dynamic group in your tenancy. You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. You can use this name or the OCID when writing policies that apply to the dynamic group. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/Concepts/policies.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.

func (IdentityClient) CreateGroup Uses

func (client IdentityClient) CreateGroup(ctx context.Context, request CreateGroupRequest) (response CreateGroupResponse, err error)

CreateGroup Creates a new group in your tenancy. You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the group, which must be unique across all groups in your tenancy and cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/Concepts/policies.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.

func (IdentityClient) CreateIdentityProvider Uses

func (client IdentityClient) CreateIdentityProvider(ctx context.Context, request CreateIdentityProviderRequest) (response CreateIdentityProviderResponse, err error)

CreateIdentityProvider Creates a new identity provider in your tenancy. For more information, see Identity Providers and Federation (https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm). You must specify your tenancy's OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the `IdentityProvider`, which must be unique across all `IdentityProvider` objects in your tenancy and cannot be changed. You must also specify a *description* for the `IdentityProvider` (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateIdentityProvider. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

func (IdentityClient) CreateIdpGroupMapping Uses

func (client IdentityClient) CreateIdpGroupMapping(ctx context.Context, request CreateIdpGroupMappingRequest) (response CreateIdpGroupMappingResponse, err error)

CreateIdpGroupMapping Creates a single mapping between an IdP group and an IAM Service Group.

func (IdentityClient) CreateMfaTotpDevice Uses

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.

func (IdentityClient) CreateNetworkSource Uses

func (client IdentityClient) CreateNetworkSource(ctx context.Context, request CreateNetworkSourceRequest) (response CreateNetworkSourceResponse, err error)

CreateNetworkSource Creates a new network source in your tenancy. You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the network source, which must be unique across all network sources in your tenancy, and cannot be changed. You can use this name or the OCID when writing policies that apply to the network source. For more information about policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm). You must also specify a *description* for the network source (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateNetworkSource. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed IP address specified in your network source. For more information, see Managing Network Sources (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).

func (IdentityClient) CreateOAuthClientCredential Uses

func (client IdentityClient) CreateOAuthClientCredential(ctx context.Context, request CreateOAuthClientCredentialRequest) (response CreateOAuthClientCredentialResponse, err error)

CreateOAuthClientCredential Creates Oauth token for the user

func (IdentityClient) CreateOrResetUIPassword Uses

func (client IdentityClient) CreateOrResetUIPassword(ctx context.Context, request CreateOrResetUIPasswordRequest) (response CreateOrResetUIPasswordResponse, err error)

CreateOrResetUIPassword Creates a new Console one-time password for the specified user. For more information about user credentials, see User Credentials (https://docs.cloud.oracle.com/Content/Identity/Concepts/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. **Note:** The user's Console login is the unique name you specified when you created the user (see CreateUser).

func (IdentityClient) CreatePolicy Uses

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 Getting Started with Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm). You must specify a *name* for the policy, which must be unique across all policies in your tenancy and cannot be changed. You must also specify a *description* for the policy (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdatePolicy. You must specify one or more policy statements in the statements array. For information about writing policies, see How Policies Work (https://docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm) and Common Policies (https://docs.cloud.oracle.com/Content/Identity/Concepts/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.

func (IdentityClient) CreateRegionSubscription Uses

func (client IdentityClient) CreateRegionSubscription(ctx context.Context, request CreateRegionSubscriptionRequest) (response CreateRegionSubscriptionResponse, err error)

CreateRegionSubscription Creates a subscription to a region for a tenancy.

func (IdentityClient) CreateSmtpCredential Uses

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.

func (IdentityClient) CreateSwiftPassword Uses

func (client IdentityClient) CreateSwiftPassword(ctx context.Context, request CreateSwiftPasswordRequest) (response CreateSwiftPasswordResponse, err error)

CreateSwiftPassword **Deprecated. Use CreateAuthToken instead.** Creates a new Swift password for the specified user. For information about what Swift passwords are for, see Managing User Credentials (https://docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm). You must specify a *description* for the Swift password (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateSwiftPassword. Every user has permission to create a Swift password for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to create a Swift password for any user, including themselves.

func (IdentityClient) CreateTag Uses

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.

func (IdentityClient) CreateTagDefault Uses

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.

func (IdentityClient) CreateTagNamespace Uses

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.

func (IdentityClient) CreateUser Uses

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 o