identity

package
v3.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2018 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddUserToGroupDetails 

type AddUserToGroupDetails struct {

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

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

AddUserToGroupDetails The representation of AddUserToGroupDetails

func (AddUserToGroupDetails) String 

func (m AddUserToGroupDetails) String() string

type AddUserToGroupRequest 

type AddUserToGroupRequest struct {

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

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

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

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

AddUserToGroupRequest wrapper for the AddUserToGroup operation

func (AddUserToGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (AddUserToGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (AddUserToGroupRequest) String 

func (request AddUserToGroupRequest) String() string

type AddUserToGroupResponse 

type AddUserToGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

AddUserToGroupResponse wrapper for the AddUserToGroup operation

func (AddUserToGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (AddUserToGroupResponse) String 

func (response AddUserToGroupResponse) String() string

type ApiKey 

type ApiKey struct {

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

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

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

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

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

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

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

ApiKey A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known as an *API signing key*. Specifically, this is the public key from the key pair. The private key remains with the user calling the API. For information about generating a key pair in the required PEM format, see Required Keys and OCIDs (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm).

func (ApiKey) String 

func (m ApiKey) String() string

type ApiKeyLifecycleStateEnum 

type ApiKeyLifecycleStateEnum string

ApiKeyLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiKeyLifecycleStateEnum

func GetApiKeyLifecycleStateEnumValues 

func GetApiKeyLifecycleStateEnumValues() []ApiKeyLifecycleStateEnum

GetApiKeyLifecycleStateEnumValues Enumerates the set of values for ApiKeyLifecycleStateEnum

type AuthToken added in v1.6.0 

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.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm).

func (AuthToken) String added in v1.6.0 

func (m AuthToken) String() string

type AuthTokenLifecycleStateEnum added in v1.6.0 

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 added in v1.6.0 

func GetAuthTokenLifecycleStateEnumValues() []AuthTokenLifecycleStateEnum

GetAuthTokenLifecycleStateEnumValues Enumerates the set of values for AuthTokenLifecycleStateEnum

type AvailabilityDomain 

type AvailabilityDomain struct {

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

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

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

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

func (AvailabilityDomain) String 

func (m AvailabilityDomain) String() string

type Compartment 

type Compartment struct {

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

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

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

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

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm) and also Setting Up Your Tenancy (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

func (Compartment) String 

func (m Compartment) String() string

type CompartmentLifecycleStateEnum 

type CompartmentLifecycleStateEnum string

CompartmentLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CompartmentLifecycleStateEnum

func GetCompartmentLifecycleStateEnumValues 

func GetCompartmentLifecycleStateEnumValues() []CompartmentLifecycleStateEnum

GetCompartmentLifecycleStateEnumValues Enumerates the set of values for CompartmentLifecycleStateEnum

type CreateApiKeyDetails 

type CreateApiKeyDetails struct {

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

CreateApiKeyDetails The representation of CreateApiKeyDetails

func (CreateApiKeyDetails) String 

func (m CreateApiKeyDetails) String() string

type CreateAuthTokenDetails added in v1.6.0 

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 added in v1.6.0 

func (m CreateAuthTokenDetails) String() string

type CreateAuthTokenRequest added in v1.6.0 

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 added in v1.6.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateAuthTokenRequest) RetryPolicy added in v1.6.0 

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

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

func (CreateAuthTokenRequest) String added in v1.6.0 

func (request CreateAuthTokenRequest) String() string

type CreateAuthTokenResponse added in v1.6.0 

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 added in v1.6.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateAuthTokenResponse) String added in v1.6.0 

func (response CreateAuthTokenResponse) String() string

type CreateCompartmentDetails 

type CreateCompartmentDetails struct {

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateCompartmentDetails The representation of CreateCompartmentDetails

func (CreateCompartmentDetails) String 

func (m CreateCompartmentDetails) String() string

type CreateCompartmentRequest 

type CreateCompartmentRequest struct {

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

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

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

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

CreateCompartmentRequest wrapper for the CreateCompartment operation

func (CreateCompartmentRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateCompartmentRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateCompartmentRequest) String 

func (request CreateCompartmentRequest) String() string

type CreateCompartmentResponse 

type CreateCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateCompartmentResponse wrapper for the CreateCompartment operation

func (CreateCompartmentResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateCompartmentResponse) String 

func (response CreateCompartmentResponse) String() string

type CreateCustomerSecretKeyDetails 

type CreateCustomerSecretKeyDetails struct {

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

CreateCustomerSecretKeyDetails The representation of CreateCustomerSecretKeyDetails

func (CreateCustomerSecretKeyDetails) String 

func (m CreateCustomerSecretKeyDetails) String() string

type CreateCustomerSecretKeyRequest 

type CreateCustomerSecretKeyRequest struct {

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

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

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

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

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

CreateCustomerSecretKeyRequest wrapper for the CreateCustomerSecretKey operation

func (CreateCustomerSecretKeyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateCustomerSecretKeyRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateCustomerSecretKeyRequest) String 

func (request CreateCustomerSecretKeyRequest) String() string

type CreateCustomerSecretKeyResponse 

type CreateCustomerSecretKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateCustomerSecretKeyResponse wrapper for the CreateCustomerSecretKey operation

func (CreateCustomerSecretKeyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateCustomerSecretKeyResponse) String 

func (response CreateCustomerSecretKeyResponse) String() string

type CreateDynamicGroupDetails added in v1.1.0 

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.us-phoenix-1.oraclecloud.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"`
}

CreateDynamicGroupDetails Properties for creating a dynamic group.

func (CreateDynamicGroupDetails) String added in v1.1.0 

func (m CreateDynamicGroupDetails) String() string

type CreateDynamicGroupRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateDynamicGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateDynamicGroupRequest) String added in v1.1.0 

func (request CreateDynamicGroupRequest) String() string

type CreateDynamicGroupResponse added in v1.1.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateDynamicGroupResponse) String added in v1.1.0 

func (response CreateDynamicGroupResponse) String() string

type CreateGroupDetails 

type CreateGroupDetails struct {

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

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

	// The description you assign to the group during creation. Does not have to be unique, and it's changeable.
	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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateGroupDetails The representation of CreateGroupDetails

func (CreateGroupDetails) String 

func (m CreateGroupDetails) String() string

type CreateGroupRequest 

type CreateGroupRequest struct {

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

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

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

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

CreateGroupRequest wrapper for the CreateGroup operation

func (CreateGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateGroupRequest) String 

func (request CreateGroupRequest) String() string

type CreateGroupResponse 

type CreateGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateGroupResponse wrapper for the CreateGroup operation

func (CreateGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateGroupResponse) String 

func (response CreateGroupResponse) String() string

type CreateIdentityProviderDetails 

type CreateIdentityProviderDetails interface {

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

CreateIdentityProviderDetails The representation of CreateIdentityProviderDetails

type CreateIdentityProviderDetailsProductTypeEnum 

type CreateIdentityProviderDetailsProductTypeEnum string

CreateIdentityProviderDetailsProductTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CreateIdentityProviderDetailsProductTypeEnum

func GetCreateIdentityProviderDetailsProductTypeEnumValues 

func GetCreateIdentityProviderDetailsProductTypeEnumValues() []CreateIdentityProviderDetailsProductTypeEnum

GetCreateIdentityProviderDetailsProductTypeEnumValues Enumerates the set of values for CreateIdentityProviderDetailsProductTypeEnum

type CreateIdentityProviderRequest 

type CreateIdentityProviderRequest struct {

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

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

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

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

CreateIdentityProviderRequest wrapper for the CreateIdentityProvider operation

func (CreateIdentityProviderRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateIdentityProviderRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateIdentityProviderRequest) String 

func (request CreateIdentityProviderRequest) String() string

type CreateIdentityProviderResponse 

type CreateIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateIdentityProviderResponse wrapper for the CreateIdentityProvider operation

func (CreateIdentityProviderResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateIdentityProviderResponse) String 

func (response CreateIdentityProviderResponse) String() string

type CreateIdpGroupMappingDetails 

type CreateIdpGroupMappingDetails struct {

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

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

CreateIdpGroupMappingDetails The representation of CreateIdpGroupMappingDetails

func (CreateIdpGroupMappingDetails) String 

func (m CreateIdpGroupMappingDetails) String() string

type CreateIdpGroupMappingRequest 

type CreateIdpGroupMappingRequest struct {

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

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

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

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

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

CreateIdpGroupMappingRequest wrapper for the CreateIdpGroupMapping operation

func (CreateIdpGroupMappingRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateIdpGroupMappingRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateIdpGroupMappingRequest) String 

func (request CreateIdpGroupMappingRequest) String() string

type CreateIdpGroupMappingResponse 

type CreateIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateIdpGroupMappingResponse wrapper for the CreateIdpGroupMapping operation

func (CreateIdpGroupMappingResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateIdpGroupMappingResponse) String 

func (response CreateIdpGroupMappingResponse) String() string

type CreateOrResetUIPasswordRequest 

type CreateOrResetUIPasswordRequest struct {

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

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

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

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

CreateOrResetUIPasswordRequest wrapper for the CreateOrResetUIPassword operation

func (CreateOrResetUIPasswordRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateOrResetUIPasswordRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateOrResetUIPasswordRequest) String 

func (request CreateOrResetUIPasswordRequest) String() string

type CreateOrResetUIPasswordResponse 

type CreateOrResetUIPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateOrResetUIPasswordResponse wrapper for the CreateOrResetUIPassword operation

func (CreateOrResetUIPasswordResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateOrResetUIPasswordResponse) String 

func (response CreateOrResetUIPasswordResponse) String() string

type CreatePolicyDetails 

type CreatePolicyDetails struct {

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

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

	// An array of policy statements written in the policy language. See
	// How Policies Work (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policies.htm) and
	// Common Policies (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreatePolicyDetails The representation of CreatePolicyDetails

func (CreatePolicyDetails) String 

func (m CreatePolicyDetails) String() string

type CreatePolicyRequest 

type CreatePolicyRequest struct {

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

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

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

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

CreatePolicyRequest wrapper for the CreatePolicy operation

func (CreatePolicyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreatePolicyRequest) RetryPolicy added in v1.3.0 

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

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

func (CreatePolicyRequest) String 

func (request CreatePolicyRequest) String() string

type CreatePolicyResponse 

type CreatePolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreatePolicyResponse wrapper for the CreatePolicy operation

func (CreatePolicyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreatePolicyResponse) String 

func (response CreatePolicyResponse) String() string

type CreateRegionSubscriptionDetails 

type CreateRegionSubscriptionDetails struct {

	// The regions's key.
	// Allowed values are:
	// - `PHX`
	// - `IAD`
	// - `FRA`
	// - `LHR`
	// Example: `PHX`
	RegionKey *string `mandatory:"true" json:"regionKey"`
}

CreateRegionSubscriptionDetails The representation of CreateRegionSubscriptionDetails

func (CreateRegionSubscriptionDetails) String 

func (m CreateRegionSubscriptionDetails) String() string

type CreateRegionSubscriptionRequest 

type CreateRegionSubscriptionRequest struct {

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

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

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

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

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

CreateRegionSubscriptionRequest wrapper for the CreateRegionSubscription operation

func (CreateRegionSubscriptionRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateRegionSubscriptionRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateRegionSubscriptionRequest) String 

func (request CreateRegionSubscriptionRequest) String() string

type CreateRegionSubscriptionResponse 

type CreateRegionSubscriptionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

CreateRegionSubscriptionResponse wrapper for the CreateRegionSubscription operation

func (CreateRegionSubscriptionResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateRegionSubscriptionResponse) String 

func (response CreateRegionSubscriptionResponse) String() string

type CreateSaml2IdentityProviderDetails 

type CreateSaml2IdentityProviderDetails struct {

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

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

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

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

CreateSaml2IdentityProviderDetails The representation of CreateSaml2IdentityProviderDetails

func (CreateSaml2IdentityProviderDetails) GetCompartmentId 

func (m CreateSaml2IdentityProviderDetails) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CreateSaml2IdentityProviderDetails) GetDefinedTags added in v1.1.0 

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

GetDefinedTags returns DefinedTags

func (CreateSaml2IdentityProviderDetails) GetDescription 

func (m CreateSaml2IdentityProviderDetails) GetDescription() *string

GetDescription returns Description

func (CreateSaml2IdentityProviderDetails) GetFreeformTags added in v1.1.0 

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

GetFreeformTags returns FreeformTags

func (CreateSaml2IdentityProviderDetails) GetName 

func (m CreateSaml2IdentityProviderDetails) GetName() *string

GetName returns Name

func (CreateSaml2IdentityProviderDetails) GetProductType 

func (m CreateSaml2IdentityProviderDetails) GetProductType() CreateIdentityProviderDetailsProductTypeEnum

GetProductType returns ProductType

func (CreateSaml2IdentityProviderDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (CreateSaml2IdentityProviderDetails) String 

func (m CreateSaml2IdentityProviderDetails) String() string

type CreateSmtpCredentialDetails added in v1.2.0 

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 added in v1.2.0 

func (m CreateSmtpCredentialDetails) String() string

type CreateSmtpCredentialRequest added in v1.2.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateSmtpCredentialRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateSmtpCredentialRequest) String added in v1.2.0 

func (request CreateSmtpCredentialRequest) String() string

type CreateSmtpCredentialResponse added in v1.2.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateSmtpCredentialResponse) String added in v1.2.0 

func (response CreateSmtpCredentialResponse) String() string

type CreateSwiftPasswordDetails 

type CreateSwiftPasswordDetails struct {

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

CreateSwiftPasswordDetails The representation of CreateSwiftPasswordDetails

func (CreateSwiftPasswordDetails) String 

func (m CreateSwiftPasswordDetails) String() string

type CreateSwiftPasswordRequest 

type CreateSwiftPasswordRequest struct {

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

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

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

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

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

CreateSwiftPasswordRequest wrapper for the CreateSwiftPassword operation

func (CreateSwiftPasswordRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateSwiftPasswordRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateSwiftPasswordRequest) String 

func (request CreateSwiftPasswordRequest) String() string

type CreateSwiftPasswordResponse 

type CreateSwiftPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateSwiftPasswordResponse wrapper for the CreateSwiftPassword operation

func (CreateSwiftPasswordResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateSwiftPasswordResponse) String 

func (response CreateSwiftPasswordResponse) String() string

type CreateTagDetails added in v1.1.0 

type CreateTagDetails struct {

	// The name you assign to the tag during creation. 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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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"`
}

CreateTagDetails The representation of CreateTagDetails

func (CreateTagDetails) String added in v1.1.0 

func (m CreateTagDetails) String() string

type CreateTagNamespaceDetails added in v1.1.0 

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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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 added in v1.1.0 

func (m CreateTagNamespaceDetails) String() string

type CreateTagNamespaceRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateTagNamespaceRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateTagNamespaceRequest) String added in v1.1.0 

func (request CreateTagNamespaceRequest) String() string

type CreateTagNamespaceResponse added in v1.1.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateTagNamespaceResponse) String added in v1.1.0 

func (response CreateTagNamespaceResponse) String() string

type CreateTagRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateTagRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateTagRequest) String added in v1.1.0 

func (request CreateTagRequest) String() string

type CreateTagResponse added in v1.1.0 

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

CreateTagResponse wrapper for the CreateTag operation

func (CreateTagResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateTagResponse) String added in v1.1.0 

func (response CreateTagResponse) String() string

type CreateUserDetails 

type CreateUserDetails struct {

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

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

	// The description you assign to the user during creation. Does not have to be unique, and it's changeable.
	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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateUserDetails The representation of CreateUserDetails

func (CreateUserDetails) String 

func (m CreateUserDetails) String() string

type CreateUserRequest 

type CreateUserRequest struct {

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

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

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

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

CreateUserRequest wrapper for the CreateUser operation

func (CreateUserRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (CreateUserRequest) RetryPolicy added in v1.3.0 

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

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

func (CreateUserRequest) String 

func (request CreateUserRequest) String() string

type CreateUserResponse 

type CreateUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateUserResponse wrapper for the CreateUser operation

func (CreateUserResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateUserResponse) String 

func (response CreateUserResponse) String() string

type CustomerSecretKey 

type CustomerSecretKey struct {

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

	// The 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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm).

func (CustomerSecretKey) String 

func (m CustomerSecretKey) String() string

type CustomerSecretKeyLifecycleStateEnum 

type CustomerSecretKeyLifecycleStateEnum string

CustomerSecretKeyLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CustomerSecretKeyLifecycleStateEnum

func GetCustomerSecretKeyLifecycleStateEnumValues 

func GetCustomerSecretKeyLifecycleStateEnumValues() []CustomerSecretKeyLifecycleStateEnum

GetCustomerSecretKeyLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeyLifecycleStateEnum

type CustomerSecretKeySummary 

type CustomerSecretKeySummary struct {

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

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

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

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

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

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

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

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

func (CustomerSecretKeySummary) String 

func (m CustomerSecretKeySummary) String() string

type CustomerSecretKeySummaryLifecycleStateEnum 

type CustomerSecretKeySummaryLifecycleStateEnum string

CustomerSecretKeySummaryLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CustomerSecretKeySummaryLifecycleStateEnum

func GetCustomerSecretKeySummaryLifecycleStateEnumValues 

func GetCustomerSecretKeySummaryLifecycleStateEnumValues() []CustomerSecretKeySummaryLifecycleStateEnum

GetCustomerSecretKeySummaryLifecycleStateEnumValues Enumerates the set of values for CustomerSecretKeySummaryLifecycleStateEnum

type DeleteApiKeyRequest 

type DeleteApiKeyRequest struct {

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

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

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

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

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

DeleteApiKeyRequest wrapper for the DeleteApiKey operation

func (DeleteApiKeyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteApiKeyRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteApiKeyRequest) String 

func (request DeleteApiKeyRequest) String() string

type DeleteApiKeyResponse 

type DeleteApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteApiKeyResponse wrapper for the DeleteApiKey operation

func (DeleteApiKeyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteApiKeyResponse) String 

func (response DeleteApiKeyResponse) String() string

type DeleteAuthTokenRequest added in v1.6.0 

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 added in v1.6.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteAuthTokenRequest) RetryPolicy added in v1.6.0 

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

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

func (DeleteAuthTokenRequest) String added in v1.6.0 

func (request DeleteAuthTokenRequest) String() string

type DeleteAuthTokenResponse added in v1.6.0 

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 added in v1.6.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteAuthTokenResponse) String added in v1.6.0 

func (response DeleteAuthTokenResponse) String() string

type DeleteCompartmentRequest 

type DeleteCompartmentRequest struct {

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

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

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

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

DeleteCompartmentRequest wrapper for the DeleteCompartment operation

func (DeleteCompartmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteCompartmentRequest) RetryPolicy 

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

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

func (DeleteCompartmentRequest) String 

func (request DeleteCompartmentRequest) String() string

type DeleteCompartmentResponse 

type DeleteCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DeleteCompartmentResponse wrapper for the DeleteCompartment operation

func (DeleteCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteCompartmentResponse) String 

func (response DeleteCompartmentResponse) String() string

type DeleteCustomerSecretKeyRequest 

type DeleteCustomerSecretKeyRequest struct {

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

	// The 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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteCustomerSecretKeyRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteCustomerSecretKeyRequest) String 

func (request DeleteCustomerSecretKeyRequest) String() string

type DeleteCustomerSecretKeyResponse 

type DeleteCustomerSecretKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteCustomerSecretKeyResponse wrapper for the DeleteCustomerSecretKey operation

func (DeleteCustomerSecretKeyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteCustomerSecretKeyResponse) String 

func (response DeleteCustomerSecretKeyResponse) String() string

type DeleteDynamicGroupRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteDynamicGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteDynamicGroupRequest) String added in v1.1.0 

func (request DeleteDynamicGroupRequest) String() string

type DeleteDynamicGroupResponse added in v1.1.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDynamicGroupResponse) String added in v1.1.0 

func (response DeleteDynamicGroupResponse) String() string

type DeleteGroupRequest 

type DeleteGroupRequest struct {

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

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

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

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

DeleteGroupRequest wrapper for the DeleteGroup operation

func (DeleteGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteGroupRequest) String 

func (request DeleteGroupRequest) String() string

type DeleteGroupResponse 

type DeleteGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteGroupResponse wrapper for the DeleteGroup operation

func (DeleteGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteGroupResponse) String 

func (response DeleteGroupResponse) String() string

type DeleteIdentityProviderRequest 

type DeleteIdentityProviderRequest struct {

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

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

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

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

DeleteIdentityProviderRequest wrapper for the DeleteIdentityProvider operation

func (DeleteIdentityProviderRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteIdentityProviderRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteIdentityProviderRequest) String 

func (request DeleteIdentityProviderRequest) String() string

type DeleteIdentityProviderResponse 

type DeleteIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteIdentityProviderResponse wrapper for the DeleteIdentityProvider operation

func (DeleteIdentityProviderResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteIdentityProviderResponse) String 

func (response DeleteIdentityProviderResponse) String() string

type DeleteIdpGroupMappingRequest 

type DeleteIdpGroupMappingRequest struct {

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

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

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

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

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

DeleteIdpGroupMappingRequest wrapper for the DeleteIdpGroupMapping operation

func (DeleteIdpGroupMappingRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteIdpGroupMappingRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteIdpGroupMappingRequest) String 

func (request DeleteIdpGroupMappingRequest) String() string

type DeleteIdpGroupMappingResponse 

type DeleteIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteIdpGroupMappingResponse wrapper for the DeleteIdpGroupMapping operation

func (DeleteIdpGroupMappingResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteIdpGroupMappingResponse) String 

func (response DeleteIdpGroupMappingResponse) String() string

type DeletePolicyRequest 

type DeletePolicyRequest struct {

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

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

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

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

DeletePolicyRequest wrapper for the DeletePolicy operation

func (DeletePolicyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeletePolicyRequest) RetryPolicy added in v1.3.0 

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

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

func (DeletePolicyRequest) String 

func (request DeletePolicyRequest) String() string

type DeletePolicyResponse 

type DeletePolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeletePolicyResponse wrapper for the DeletePolicy operation

func (DeletePolicyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeletePolicyResponse) String 

func (response DeletePolicyResponse) String() string

type DeleteSmtpCredentialRequest added in v1.2.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteSmtpCredentialRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteSmtpCredentialRequest) String added in v1.2.0 

func (request DeleteSmtpCredentialRequest) String() string

type DeleteSmtpCredentialResponse added in v1.2.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteSmtpCredentialResponse) String added in v1.2.0 

func (response DeleteSmtpCredentialResponse) String() string

type DeleteSwiftPasswordRequest 

type DeleteSwiftPasswordRequest struct {

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

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

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

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

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

DeleteSwiftPasswordRequest wrapper for the DeleteSwiftPassword operation

func (DeleteSwiftPasswordRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteSwiftPasswordRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteSwiftPasswordRequest) String 

func (request DeleteSwiftPasswordRequest) String() string

type DeleteSwiftPasswordResponse 

type DeleteSwiftPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteSwiftPasswordResponse wrapper for the DeleteSwiftPassword operation

func (DeleteSwiftPasswordResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteSwiftPasswordResponse) String 

func (response DeleteSwiftPasswordResponse) String() string

type DeleteUserRequest 

type DeleteUserRequest struct {

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

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

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

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

DeleteUserRequest wrapper for the DeleteUser operation

func (DeleteUserRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (DeleteUserRequest) RetryPolicy added in v1.3.0 

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

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

func (DeleteUserRequest) String 

func (request DeleteUserRequest) String() string

type DeleteUserResponse 

type DeleteUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteUserResponse wrapper for the DeleteUser operation

func (DeleteUserResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteUserResponse) String 

func (response DeleteUserResponse) String() string

type DynamicGroup added in v1.1.0 

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.us-phoenix-1.oraclecloud.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"`
}

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.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm).

func (DynamicGroup) String added in v1.1.0 

func (m DynamicGroup) String() string

type DynamicGroupLifecycleStateEnum added in v1.1.0 

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 added in v1.1.0 

func GetDynamicGroupLifecycleStateEnumValues() []DynamicGroupLifecycleStateEnum

GetDynamicGroupLifecycleStateEnumValues Enumerates the set of values for DynamicGroupLifecycleStateEnum

type FaultDomain 

type FaultDomain struct {

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

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

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

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

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

func (FaultDomain) String 

func (m FaultDomain) String() string

type GetCompartmentRequest 

type GetCompartmentRequest struct {

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

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

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

GetCompartmentRequest wrapper for the GetCompartment operation

func (GetCompartmentRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetCompartmentRequest) RetryPolicy added in v1.3.0 

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

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

func (GetCompartmentRequest) String 

func (request GetCompartmentRequest) String() string

type GetCompartmentResponse 

type GetCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetCompartmentResponse wrapper for the GetCompartment operation

func (GetCompartmentResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetCompartmentResponse) String 

func (response GetCompartmentResponse) String() string

type GetDynamicGroupRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetDynamicGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (GetDynamicGroupRequest) String added in v1.1.0 

func (request GetDynamicGroupRequest) String() string

type GetDynamicGroupResponse added in v1.1.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetDynamicGroupResponse) String added in v1.1.0 

func (response GetDynamicGroupResponse) String() string

type GetGroupRequest 

type GetGroupRequest struct {

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

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

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

GetGroupRequest wrapper for the GetGroup operation

func (GetGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (GetGroupRequest) String 

func (request GetGroupRequest) String() string

type GetGroupResponse 

type GetGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetGroupResponse wrapper for the GetGroup operation

func (GetGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetGroupResponse) String 

func (response GetGroupResponse) String() string

type GetIdentityProviderRequest 

type GetIdentityProviderRequest struct {

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

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

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

GetIdentityProviderRequest wrapper for the GetIdentityProvider operation

func (GetIdentityProviderRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetIdentityProviderRequest) RetryPolicy added in v1.3.0 

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

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

func (GetIdentityProviderRequest) String 

func (request GetIdentityProviderRequest) String() string

type GetIdentityProviderResponse 

type GetIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetIdentityProviderResponse wrapper for the GetIdentityProvider operation

func (GetIdentityProviderResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetIdentityProviderResponse) String 

func (response GetIdentityProviderResponse) String() string

type GetIdpGroupMappingRequest 

type GetIdpGroupMappingRequest struct {

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

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

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

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

GetIdpGroupMappingRequest wrapper for the GetIdpGroupMapping operation

func (GetIdpGroupMappingRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetIdpGroupMappingRequest) RetryPolicy added in v1.3.0 

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

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

func (GetIdpGroupMappingRequest) String 

func (request GetIdpGroupMappingRequest) String() string

type GetIdpGroupMappingResponse 

type GetIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetIdpGroupMappingResponse wrapper for the GetIdpGroupMapping operation

func (GetIdpGroupMappingResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetIdpGroupMappingResponse) String 

func (response GetIdpGroupMappingResponse) String() string

type GetPolicyRequest 

type GetPolicyRequest struct {

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

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

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

GetPolicyRequest wrapper for the GetPolicy operation

func (GetPolicyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetPolicyRequest) RetryPolicy added in v1.3.0 

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

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

func (GetPolicyRequest) String 

func (request GetPolicyRequest) String() string

type GetPolicyResponse 

type GetPolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetPolicyResponse wrapper for the GetPolicy operation

func (GetPolicyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetPolicyResponse) String 

func (response GetPolicyResponse) String() string

type GetTagNamespaceRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetTagNamespaceRequest) RetryPolicy added in v1.3.0 

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

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

func (GetTagNamespaceRequest) String added in v1.1.0 

func (request GetTagNamespaceRequest) String() string

type GetTagNamespaceResponse added in v1.1.0 

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 added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetTagNamespaceResponse) String added in v1.1.0 

func (response GetTagNamespaceResponse) String() string

type GetTagRequest added in v1.1.0 

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 added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetTagRequest) RetryPolicy added in v1.3.0 

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

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

func (GetTagRequest) String added in v1.1.0 

func (request GetTagRequest) String() string

type GetTagResponse added in v1.1.0 

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

GetTagResponse wrapper for the GetTag operation

func (GetTagResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetTagResponse) String added in v1.1.0 

func (response GetTagResponse) String() string

type GetTenancyRequest 

type GetTenancyRequest struct {

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

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

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

GetTenancyRequest wrapper for the GetTenancy operation

func (GetTenancyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetTenancyRequest) RetryPolicy added in v1.3.0 

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

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

func (GetTenancyRequest) String 

func (request GetTenancyRequest) String() string

type GetTenancyResponse 

type GetTenancyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

GetTenancyResponse wrapper for the GetTenancy operation

func (GetTenancyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetTenancyResponse) String 

func (response GetTenancyResponse) String() string

type GetUserGroupMembershipRequest 

type GetUserGroupMembershipRequest struct {

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

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

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

GetUserGroupMembershipRequest wrapper for the GetUserGroupMembership operation

func (GetUserGroupMembershipRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetUserGroupMembershipRequest) RetryPolicy added in v1.3.0 

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

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

func (GetUserGroupMembershipRequest) String 

func (request GetUserGroupMembershipRequest) String() string

type GetUserGroupMembershipResponse 

type GetUserGroupMembershipResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetUserGroupMembershipResponse wrapper for the GetUserGroupMembership operation

func (GetUserGroupMembershipResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetUserGroupMembershipResponse) String 

func (response GetUserGroupMembershipResponse) String() string

type GetUserRequest 

type GetUserRequest struct {

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

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

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

GetUserRequest wrapper for the GetUser operation

func (GetUserRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (GetUserRequest) RetryPolicy added in v1.3.0 

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

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

func (GetUserRequest) String 

func (request GetUserRequest) String() string

type GetUserResponse 

type GetUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetUserResponse wrapper for the GetUser operation

func (GetUserResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (GetUserResponse) String 

func (response GetUserResponse) String() string

type GetWorkRequestRequest 

type GetWorkRequestRequest struct {

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

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

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

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

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

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type Group 

type Group struct {

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

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

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

	// The description you assign to the group. Does not have to be unique, and it's changeable.
	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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

func (Group) String 

func (m Group) String() string

type GroupLifecycleStateEnum 

type GroupLifecycleStateEnum string

GroupLifecycleStateEnum Enum with underlying type: string 

const (
	GroupLifecycleStateCreating GroupLifecycleStateEnum = "CREATING"
	GroupLifecycleStateActive   GroupLifecycleStateEnum = "ACTIVE"
	GroupLifecycleStateInactive GroupLifecycleStateEnum = "INACTIVE"
	GroupLifecycleStateDeleting GroupLifecycleStateEnum = "DELETING"
	GroupLifecycleStateDeleted  GroupLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for GroupLifecycleStateEnum

func GetGroupLifecycleStateEnumValues 

func GetGroupLifecycleStateEnumValues() []GroupLifecycleStateEnum

GetGroupLifecycleStateEnumValues Enumerates the set of values for GroupLifecycleStateEnum

type IdentityClient 

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

IdentityClient a client for Identity

func NewIdentityClientWithConfigurationProvider 

func NewIdentityClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client IdentityClient, err error)

NewIdentityClientWithConfigurationProvider Creates a new default Identity client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (IdentityClient) AddUserToGroup 

func (client IdentityClient) AddUserToGroup(ctx context.Context, request AddUserToGroupRequest) (response AddUserToGroupResponse, err error)

AddUserToGroup Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

func (*IdentityClient) ConfigurationProvider 

func (client *IdentityClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (IdentityClient) CreateAuthToken added in v1.6.0 

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.us-phoenix-1.oraclecloud.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 

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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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 

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.us-phoenix-1.oraclecloud.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 added in v1.1.0 

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.us-phoenix-1.oraclecloud.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 accross 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.us-phoenix-1.oraclecloud.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 

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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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 

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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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 

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) CreateOrResetUIPassword 

func (client IdentityClient) CreateOrResetUIPassword(ctx context.Context, request CreateOrResetUIPasswordRequest) (response CreateOrResetUIPasswordResponse, err error)

CreateOrResetUIPassword Creates a new Console one-time password for the specified user. For more information about user credentials, see User Credentials (https://docs.us-phoenix-1.oraclecloud.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 

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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policies.htm) and Common Policies (https://docs.us-phoenix-1.oraclecloud.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 

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 added in v1.2.0 

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 

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.us-phoenix-1.oraclecloud.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 added in v1.1.0 

func (client IdentityClient) CreateTag(ctx context.Context, request CreateTagRequest) (response CreateTagResponse, err error)

CreateTag Creates a new tag in the specified tag namespace. You must specify either the OCID or the name of the tag namespace that will contain this tag definition. You must also 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. You must also specify a *description* for the tag. It does not have to be unique, and you can change it with UpdateTag.

func (IdentityClient) CreateTagNamespace added in v1.1.0 

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. Tag namespaces cannot be deleted, but they can be retired. See Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring) for more information.

func (IdentityClient) CreateUser 

func (client IdentityClient) CreateUser(ctx context.Context, request CreateUserRequest) (response CreateUserResponse, err error)

CreateUser Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other IAM Service components, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You must also specify a *name* for the user, which must be unique across all users in your tenancy and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, underscores, +, and @. If you specify a name that's already in use, you'll get a 409 error. This name will be the user's login to the Console. You might want to pick a name that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses. If you delete a user and then create a new user with the same name, they'll be considered different users because they have different OCIDs. You must also specify a *description* for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateUser. You can use the field to provide the user's full name, a description, a nickname, or other information to generally identify the user. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE. A new user has no permissions until you place the user in one or more groups (see AddUserToGroup). If the user needs to access the Console, you need to provide the user a password (see CreateOrResetUIPassword). If the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a public API signing key for that user (see Required Keys and OCIDs (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) and also UploadApiKey). **Important:** Make sure to inform the new user which compartment(s) they have access to.

func (IdentityClient) DeleteApiKey 

func (client IdentityClient) DeleteApiKey(ctx context.Context, request DeleteApiKeyRequest) (response DeleteApiKeyResponse, err error)

DeleteApiKey Deletes the specified API signing key for the specified user. Every user has permission to use this operation to delete a key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to delete a key for any user, including themselves.

func (IdentityClient) DeleteAuthToken added in v1.6.0 

func (client IdentityClient) DeleteAuthToken(ctx context.Context, request DeleteAuthTokenRequest) (response DeleteAuthTokenResponse, err error)

DeleteAuthToken Deletes the specified auth token for the specified user.

func (IdentityClient) DeleteCompartment 

func (client IdentityClient) DeleteCompartment(ctx context.Context, request DeleteCompartmentRequest) (response DeleteCompartmentResponse, err error)

DeleteCompartment Deletes the specified compartment. The compartment must be empty.

func (IdentityClient) DeleteCustomerSecretKey 

func (client IdentityClient) DeleteCustomerSecretKey(ctx context.Context, request DeleteCustomerSecretKeyRequest) (response DeleteCustomerSecretKeyResponse, err error)

DeleteCustomerSecretKey Deletes the specified secret key for the specified user.

func (IdentityClient) DeleteDynamicGroup added in v1.1.0 

func (client IdentityClient) DeleteDynamicGroup(ctx context.Context, request DeleteDynamicGroupRequest) (response DeleteDynamicGroupResponse, err error)

DeleteDynamicGroup Deletes the specified dynamic group.

func (IdentityClient) DeleteGroup 

func (client IdentityClient) DeleteGroup(ctx context.Context, request DeleteGroupRequest) (response DeleteGroupResponse, err error)

DeleteGroup Deletes the specified group. The group must be empty.

func (IdentityClient) DeleteIdentityProvider 

func (client IdentityClient) DeleteIdentityProvider(ctx context.Context, request DeleteIdentityProviderRequest) (response DeleteIdentityProviderResponse, err error)

DeleteIdentityProvider Deletes the specified identity provider. The identity provider must not have any group mappings (see IdpGroupMapping).

func (IdentityClient) DeleteIdpGroupMapping 

func (client IdentityClient) DeleteIdpGroupMapping(ctx context.Context, request DeleteIdpGroupMappingRequest) (response DeleteIdpGroupMappingResponse, err error)

DeleteIdpGroupMapping Deletes the specified group mapping.

func (IdentityClient) DeletePolicy 

func (client IdentityClient) DeletePolicy(ctx context.Context, request DeletePolicyRequest) (response DeletePolicyResponse, err error)

DeletePolicy Deletes the specified policy. The deletion takes effect typically within 10 seconds.

func (IdentityClient) DeleteSmtpCredential added in v1.2.0 

func (client IdentityClient) DeleteSmtpCredential(ctx context.Context, request DeleteSmtpCredentialRequest) (response DeleteSmtpCredentialResponse, err error)

DeleteSmtpCredential Deletes the specified SMTP credential for the specified user.

func (IdentityClient) DeleteSwiftPassword 

func (client IdentityClient) DeleteSwiftPassword(ctx context.Context, request DeleteSwiftPasswordRequest) (response DeleteSwiftPasswordResponse, err error)

DeleteSwiftPassword **Deprecated. Use DeleteAuthToken instead.** Deletes the specified Swift password for the specified user.

func (IdentityClient) DeleteUser 

func (client IdentityClient) DeleteUser(ctx context.Context, request DeleteUserRequest) (response DeleteUserResponse, err error)

DeleteUser Deletes the specified user. The user must not be in any groups.

func (IdentityClient) GetCompartment 

func (client IdentityClient) GetCompartment(ctx context.Context, request GetCompartmentRequest) (response GetCompartmentResponse, err error)

GetCompartment Gets the specified compartment's information. This operation does not return a list of all the resources inside the compartment. There is no single API operation that does that. Compartments can contain multiple types of resources (instances, block storage volumes, etc.). To find out what's in a compartment, you must call the "List" operation for each resource type and specify the compartment's OCID as a query parameter in the request. For example, call the ListInstances operation in the Cloud Compute Service or the ListVolumes operation in Cloud Block Storage.

func (IdentityClient) GetDynamicGroup added in v1.1.0 

func (client IdentityClient) GetDynamicGroup(ctx context.Context, request GetDynamicGroupRequest) (response GetDynamicGroupResponse, err error)

GetDynamicGroup Gets the specified dynamic group's information.

func (IdentityClient) GetGroup 

func (client IdentityClient) GetGroup(ctx context.Context, request GetGroupRequest) (response GetGroupResponse, err error)

GetGroup Gets the specified group's information. This operation does not return a list of all the users in the group. To do that, use ListUserGroupMemberships and provide the group's OCID as a query parameter in the request.

func (IdentityClient) GetIdentityProvider 

func (client IdentityClient) GetIdentityProvider(ctx context.Context, request GetIdentityProviderRequest) (response GetIdentityProviderResponse, err error)

GetIdentityProvider Gets the specified identity provider's information.

func (IdentityClient) GetIdpGroupMapping 

func (client IdentityClient) GetIdpGroupMapping(ctx context.Context, request GetIdpGroupMappingRequest) (response GetIdpGroupMappingResponse, err error)

GetIdpGroupMapping Gets the specified group mapping.

func (IdentityClient) GetPolicy 

func (client IdentityClient) GetPolicy(ctx context.Context, request GetPolicyRequest) (response GetPolicyResponse, err error)

GetPolicy Gets the specified policy's information.

func (IdentityClient) GetTag added in v1.1.0 

func (client IdentityClient) GetTag(ctx context.Context, request GetTagRequest) (response GetTagResponse, err error)

GetTag Gets the specified tag's information.

func (IdentityClient) GetTagNamespace added in v1.1.0 

func (client IdentityClient) GetTagNamespace(ctx context.Context, request GetTagNamespaceRequest) (response GetTagNamespaceResponse, err error)

GetTagNamespace Gets the specified tag namespace's information.

func (IdentityClient) GetTenancy 

func (client IdentityClient) GetTenancy(ctx context.Context, request GetTenancyRequest) (response GetTenancyResponse, err error)

GetTenancy Get the specified tenancy's information.

func (IdentityClient) GetUser 

func (client IdentityClient) GetUser(ctx context.Context, request GetUserRequest) (response GetUserResponse, err error)

GetUser Gets the specified user's information.

func (IdentityClient) GetUserGroupMembership 

func (client IdentityClient) GetUserGroupMembership(ctx context.Context, request GetUserGroupMembershipRequest) (response GetUserGroupMembershipResponse, err error)

GetUserGroupMembership Gets the specified UserGroupMembership's information.

func (IdentityClient) GetWorkRequest 

func (client IdentityClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header for any asynchronous operation in the Identity and Access Management service.

func (IdentityClient) ListApiKeys 

func (client IdentityClient) ListApiKeys(ctx context.Context, request ListApiKeysRequest) (response ListApiKeysResponse, err error)

ListApiKeys Lists the API signing keys for the specified user. A user can have a maximum of three keys. Every user has permission to use this API call for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability.

func (IdentityClient) ListAuthTokens added in v1.6.0 

func (client IdentityClient) ListAuthTokens(ctx context.Context, request ListAuthTokensRequest) (response ListAuthTokensResponse, err error)

ListAuthTokens Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not the token itself. The actual token is returned only upon creation.

func (IdentityClient) ListAvailabilityDomains 

func (client IdentityClient) ListAvailabilityDomains(ctx context.Context, request ListAvailabilityDomainsRequest) (response ListAvailabilityDomainsResponse, err error)

ListAvailabilityDomains Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five). Note that the order of the results returned can change if availability domains are added or removed; therefore, do not create a dependency on the list order.

func (IdentityClient) ListCompartments 

func (client IdentityClient) ListCompartments(ctx context.Context, request ListCompartmentsRequest) (response ListCompartmentsResponse, err error)

ListCompartments Lists the compartments in a specified compartment. The members of the list returned depends on the values set for several parameters. With the exception of the tenancy (root compartment), the ListCompartments operation returns only the first-level child compartments in the parent compartment specified in `compartmentId`. The list does not include any subcompartments of the child compartments (grandchildren). The parameter `accessLevel` specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (the resource can be in a subcompartment). The parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the tenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY. See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).

func (IdentityClient) ListCostTrackingTags 

func (client IdentityClient) ListCostTrackingTags(ctx context.Context, request ListCostTrackingTagsRequest) (response ListCostTrackingTagsResponse, err error)

ListCostTrackingTags Lists all the tags enabled for cost-tracking in the specified tenancy. For information about cost-tracking tags, see Using Cost-tracking Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#costs).

func (IdentityClient) ListCustomerSecretKeys 

func (client IdentityClient) ListCustomerSecretKeys(ctx context.Context, request ListCustomerSecretKeysRequest) (response ListCustomerSecretKeysResponse, err error)

ListCustomerSecretKeys Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not the secret key itself. The actual secret key is returned only upon creation.

func (IdentityClient) ListDynamicGroups added in v1.1.0 

func (client IdentityClient) ListDynamicGroups(ctx context.Context, request ListDynamicGroupsRequest) (response ListDynamicGroupsResponse, err error)

ListDynamicGroups Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).

func (IdentityClient) ListFaultDomains 

func (client IdentityClient) ListFaultDomains(ctx context.Context, request ListFaultDomainsRequest) (response ListFaultDomainsResponse, err error)

ListFaultDomains Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).

func (IdentityClient) ListGroups 

func (client IdentityClient) ListGroups(ctx context.Context, request ListGroupsRequest) (response ListGroupsResponse, err error)

ListGroups Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).

func (IdentityClient) ListIdentityProviderGroups 

func (client IdentityClient) ListIdentityProviderGroups(ctx context.Context, request ListIdentityProviderGroupsRequest) (response ListIdentityProviderGroupsResponse, err error)

ListIdentityProviderGroups Lists the identity provider groups.

func (IdentityClient) ListIdentityProviders 

func (client IdentityClient) ListIdentityProviders(ctx context.Context, request ListIdentityProvidersRequest) (response ListIdentityProvidersResponse, err error)

ListIdentityProviders Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).

func (IdentityClient) ListIdpGroupMappings 

func (client IdentityClient) ListIdpGroupMappings(ctx context.Context, request ListIdpGroupMappingsRequest) (response ListIdpGroupMappingsResponse, err error)

ListIdpGroupMappings Lists the group mappings for the specified identity provider.

func (IdentityClient) ListPolicies 

func (client IdentityClient) ListPolicies(ctx context.Context, request ListPoliciesRequest) (response ListPoliciesResponse, err error)

ListPolicies Lists the policies in the specified compartment (either the tenancy or another of your compartments). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five). To determine which policies apply to a particular group or compartment, you must view the individual statements inside all your policies. There isn't a way to automatically obtain that information via the API.

func (IdentityClient) ListRegionSubscriptions 

func (client IdentityClient) ListRegionSubscriptions(ctx context.Context, request ListRegionSubscriptionsRequest) (response ListRegionSubscriptionsResponse, err error)

ListRegionSubscriptions Lists the region subscriptions for the specified tenancy.

func (IdentityClient) ListRegions 

func (client IdentityClient) ListRegions(ctx context.Context) (response ListRegionsResponse, err error)

ListRegions Lists all the regions offered by Oracle Cloud Infrastructure.

func (IdentityClient) ListSmtpCredentials added in v1.2.0 

func (client IdentityClient) ListSmtpCredentials(ctx context.Context, request ListSmtpCredentialsRequest) (response ListSmtpCredentialsResponse, err error)

ListSmtpCredentials Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID, the SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.

func (IdentityClient) ListSwiftPasswords 

func (client IdentityClient) ListSwiftPasswords(ctx context.Context, request ListSwiftPasswordsRequest) (response ListSwiftPasswordsResponse, err error)

ListSwiftPasswords **Deprecated. Use ListAuthTokens instead.** Lists the Swift passwords for the specified user. The returned object contains the password's OCID, but not the password itself. The actual password is returned only upon creation.

func (IdentityClient) ListTagNamespaces added in v1.1.0 

func (client IdentityClient) ListTagNamespaces(ctx context.Context, request ListTagNamespacesRequest) (response ListTagNamespacesResponse, err error)

ListTagNamespaces Lists the tag namespaces in the specified compartment.

func (IdentityClient) ListTags added in v1.1.0 

func (client IdentityClient) ListTags(ctx context.Context, request ListTagsRequest) (response ListTagsResponse, err error)

ListTags Lists the tag definitions in the specified tag namespace.

func (IdentityClient) ListUserGroupMemberships 

func (client IdentityClient) ListUserGroupMemberships(ctx context.Context, request ListUserGroupMembershipsRequest) (response ListUserGroupMembershipsResponse, err error)

ListUserGroupMemberships Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (see Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five)). You must also then filter the list in one of these ways: - You can limit the results to just the memberships for a given user by specifying a `userId`. - Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`. - You can set both the `userId` and `groupId` to determine if the specified user is in the specified group. If the answer is no, the response is an empty list. - Although`userId` and `groupId` are not indvidually required, you must set one of them.

func (IdentityClient) ListUsers 

func (client IdentityClient) ListUsers(ctx context.Context, request ListUsersRequest) (response ListUsersResponse, err error)

ListUsers Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm#five).

func (IdentityClient) ListWorkRequests 

func (client IdentityClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in compartment.

func (IdentityClient) RemoveUserFromGroup 

func (client IdentityClient) RemoveUserFromGroup(ctx context.Context, request RemoveUserFromGroupRequest) (response RemoveUserFromGroupResponse, err error)

RemoveUserFromGroup Removes a user from a group by deleting the corresponding `UserGroupMembership`.

func (IdentityClient) ResetIdpScimClient 

func (client IdentityClient) ResetIdpScimClient(ctx context.Context, request ResetIdpScimClientRequest) (response ResetIdpScimClientResponse, err error)

ResetIdpScimClient Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.

func (*IdentityClient) SetRegion 

func (client *IdentityClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (IdentityClient) UpdateAuthToken added in v1.6.0 

func (client IdentityClient) UpdateAuthToken(ctx context.Context, request UpdateAuthTokenRequest) (response UpdateAuthTokenResponse, err error)

UpdateAuthToken Updates the specified auth token's description.

func (IdentityClient) UpdateCompartment 

func (client IdentityClient) UpdateCompartment(ctx context.Context, request UpdateCompartmentRequest) (response UpdateCompartmentResponse, err error)

UpdateCompartment Updates the specified compartment's description or name. You can't update the root compartment.

func (IdentityClient) UpdateCustomerSecretKey 

func (client IdentityClient) UpdateCustomerSecretKey(ctx context.Context, request UpdateCustomerSecretKeyRequest) (response UpdateCustomerSecretKeyResponse, err error)

UpdateCustomerSecretKey Updates the specified secret key's description.

func (IdentityClient) UpdateDynamicGroup added in v1.1.0 

func (client IdentityClient) UpdateDynamicGroup(ctx context.Context, request UpdateDynamicGroupRequest) (response UpdateDynamicGroupResponse, err error)

UpdateDynamicGroup Updates the specified dynamic group.

func (IdentityClient) UpdateGroup 

func (client IdentityClient) UpdateGroup(ctx context.Context, request UpdateGroupRequest) (response UpdateGroupResponse, err error)

UpdateGroup Updates the specified group.

func (IdentityClient) UpdateIdentityProvider 

func (client IdentityClient) UpdateIdentityProvider(ctx context.Context, request UpdateIdentityProviderRequest) (response UpdateIdentityProviderResponse, err error)

UpdateIdentityProvider Updates the specified identity provider.

func (IdentityClient) UpdateIdpGroupMapping 

func (client IdentityClient) UpdateIdpGroupMapping(ctx context.Context, request UpdateIdpGroupMappingRequest) (response UpdateIdpGroupMappingResponse, err error)

UpdateIdpGroupMapping Updates the specified group mapping.

func (IdentityClient) UpdatePolicy 

func (client IdentityClient) UpdatePolicy(ctx context.Context, request UpdatePolicyRequest) (response UpdatePolicyResponse, err error)

UpdatePolicy Updates the specified policy. You can update the description or the policy statements themselves. Policy changes take effect typically within 10 seconds.

func (IdentityClient) UpdateSmtpCredential added in v1.2.0 

func (client IdentityClient) UpdateSmtpCredential(ctx context.Context, request UpdateSmtpCredentialRequest) (response UpdateSmtpCredentialResponse, err error)

UpdateSmtpCredential Updates the specified SMTP credential's description.

func (IdentityClient) UpdateSwiftPassword 

func (client IdentityClient) UpdateSwiftPassword(ctx context.Context, request UpdateSwiftPasswordRequest) (response UpdateSwiftPasswordResponse, err error)

UpdateSwiftPassword **Deprecated. Use UpdateAuthToken instead.** Updates the specified Swift password's description.

func (IdentityClient) UpdateTag added in v1.1.0 

func (client IdentityClient) UpdateTag(ctx context.Context, request UpdateTagRequest) (response UpdateTagResponse, err error)

UpdateTag Updates the the specified tag definition. You can update `description`, and `isRetired`.

func (IdentityClient) UpdateTagNamespace added in v1.1.0 

func (client IdentityClient) UpdateTagNamespace(ctx context.Context, request UpdateTagNamespaceRequest) (response UpdateTagNamespaceResponse, err error)

UpdateTagNamespace Updates the the specified tag namespace. You can't update the namespace name. Updating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a namespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions. To reactivate the tag definitions, you must reactivate each one indvidually *after* you reactivate the namespace, using UpdateTag. For more information about retiring tag namespaces, see Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring). You can't add a namespace with the same name as a retired namespace in the same tenancy.

func (IdentityClient) UpdateUser 

func (client IdentityClient) UpdateUser(ctx context.Context, request UpdateUserRequest) (response UpdateUserResponse, err error)

UpdateUser Updates the description of the specified user.

func (IdentityClient) UpdateUserCapabilities 

func (client IdentityClient) UpdateUserCapabilities(ctx context.Context, request UpdateUserCapabilitiesRequest) (response UpdateUserCapabilitiesResponse, err error)

UpdateUserCapabilities Updates the capabilities of the specified user.

func (IdentityClient) UpdateUserState 

func (client IdentityClient) UpdateUserState(ctx context.Context, request UpdateUserStateRequest) (response UpdateUserStateResponse, err error)

UpdateUserState Updates the state of the specified user.

func (IdentityClient) UploadApiKey 

func (client IdentityClient) UploadApiKey(ctx context.Context, request UploadApiKeyRequest) (response UploadApiKeyResponse, err error)

UploadApiKey Uploads an API signing key for the specified user. Every user has permission to use this operation to upload a key for *their own user ID*. An administrator in your organization does not need to write a policy to give users this ability. To compare, administrators who have permission to the tenancy can use this operation to upload a key for any user, including themselves. **Important:** Even though you have permission to upload an API key, you might not yet have permission to do much else. If you try calling an operation unrelated to your own credential management (e.g., `ListUsers`, `LaunchInstance`) and receive an "unauthorized" error, check with an administrator to confirm which IAM Service group(s) you're in and what access you have. Also confirm you're working in the correct compartment. After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

type IdentityProvider 

type IdentityProvider interface {

	// The OCID of the `IdentityProvider`.
	GetId() *string

	// The OCID of the tenancy containing the `IdentityProvider`.
	GetCompartmentId() *string

	// The name you assign to the `IdentityProvider` during creation. The name
	// must be unique across all `IdentityProvider` objects in the tenancy and
	// cannot be changed. This is the name federated users see when choosing
	// which identity provider to use when signing in to the Oracle Cloud Infrastructure
	// Console.
	GetName() *string

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

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

	// Date and time the `IdentityProvider` was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	GetTimeCreated() *common.SDKTime

	// The current state. After creating an `IdentityProvider`, make sure its
	// `lifecycleState` changes from CREATING to ACTIVE before using it.
	GetLifecycleState() IdentityProviderLifecycleStateEnum

	// The detailed status of INACTIVE lifecycleState.
	GetInactiveStatus() *int64

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

IdentityProvider The resulting base object when you add an identity provider to your tenancy. A Saml2IdentityProvider is a specific type of `IdentityProvider` that supports the SAML 2.0 protocol. Each `IdentityProvider` object has its own OCID. For more information, see Identity Providers and Federation (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

type IdentityProviderGroupSummary 

type IdentityProviderGroupSummary struct {

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

	// The OCID of the `IdentityProvider` this group belongs to.
	IdentityProviderId *string `mandatory:"false" json:"identityProviderId"`

	// Display name of the group
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Identifier of the group in the identity provider
	ExternalIdentifier *string `mandatory:"false" json:"externalIdentifier"`

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

	// Date and time the `IdentityProviderGroup` was last modified, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeModified *common.SDKTime `mandatory:"false" json:"timeModified"`
}

IdentityProviderGroupSummary A group created in an identity provider that can be mapped to a group in OCI

func (IdentityProviderGroupSummary) String 

func (m IdentityProviderGroupSummary) String() string

type IdentityProviderLifecycleStateEnum 

type IdentityProviderLifecycleStateEnum string

IdentityProviderLifecycleStateEnum Enum with underlying type: string 

const (
	IdentityProviderLifecycleStateCreating IdentityProviderLifecycleStateEnum = "CREATING"
	IdentityProviderLifecycleStateActive   IdentityProviderLifecycleStateEnum = "ACTIVE"
	IdentityProviderLifecycleStateInactive IdentityProviderLifecycleStateEnum = "INACTIVE"
	IdentityProviderLifecycleStateDeleting IdentityProviderLifecycleStateEnum = "DELETING"
	IdentityProviderLifecycleStateDeleted  IdentityProviderLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for IdentityProviderLifecycleStateEnum

func GetIdentityProviderLifecycleStateEnumValues 

func GetIdentityProviderLifecycleStateEnumValues() []IdentityProviderLifecycleStateEnum

GetIdentityProviderLifecycleStateEnumValues Enumerates the set of values for IdentityProviderLifecycleStateEnum

type IdpGroupMapping 

type IdpGroupMapping struct {

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

	// The OCID of the `IdentityProvider` this mapping belongs to.
	IdpId *string `mandatory:"true" json:"idpId"`

	// The name of the IdP group that is mapped to the IAM Service group.
	IdpGroupName *string `mandatory:"true" json:"idpGroupName"`

	// The OCID of the IAM Service group that is mapped to the IdP group.
	GroupId *string `mandatory:"true" json:"groupId"`

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

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

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

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

IdpGroupMapping A mapping between a single group defined by the identity provider (IdP) you're federating with and a single IAM Service Group in Oracle Cloud Infrastructure. For more information about group mappings and what they're for, see Identity Providers and Federation (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm). A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. But each `IdPGroupMapping` object is between only a single IdP group and IAM Service group. Each `IdPGroupMapping` object has its own OCID. **Note:** Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle Cloud Infrastructure Console.

func (IdpGroupMapping) String 

func (m IdpGroupMapping) String() string

type IdpGroupMappingLifecycleStateEnum 

type IdpGroupMappingLifecycleStateEnum string

IdpGroupMappingLifecycleStateEnum Enum with underlying type: string 

const (
	IdpGroupMappingLifecycleStateCreating IdpGroupMappingLifecycleStateEnum = "CREATING"
	IdpGroupMappingLifecycleStateActive   IdpGroupMappingLifecycleStateEnum = "ACTIVE"
	IdpGroupMappingLifecycleStateInactive IdpGroupMappingLifecycleStateEnum = "INACTIVE"
	IdpGroupMappingLifecycleStateDeleting IdpGroupMappingLifecycleStateEnum = "DELETING"
	IdpGroupMappingLifecycleStateDeleted  IdpGroupMappingLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for IdpGroupMappingLifecycleStateEnum

func GetIdpGroupMappingLifecycleStateEnumValues 

func GetIdpGroupMappingLifecycleStateEnumValues() []IdpGroupMappingLifecycleStateEnum

GetIdpGroupMappingLifecycleStateEnumValues Enumerates the set of values for IdpGroupMappingLifecycleStateEnum

type ListApiKeysRequest 

type ListApiKeysRequest struct {

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

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

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

ListApiKeysRequest wrapper for the ListApiKeys operation

func (ListApiKeysRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListApiKeysRequest) RetryPolicy added in v1.3.0 

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

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

func (ListApiKeysRequest) String 

func (request ListApiKeysRequest) String() string

type ListApiKeysResponse 

type ListApiKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListApiKeysResponse wrapper for the ListApiKeys operation

func (ListApiKeysResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListApiKeysResponse) String 

func (response ListApiKeysResponse) String() string

type ListAuthTokensRequest added in v1.6.0 

type ListAuthTokensRequest struct {

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

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

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

ListAuthTokensRequest wrapper for the ListAuthTokens operation

func (ListAuthTokensRequest) HTTPRequest added in v1.6.0 

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

HTTPRequest implements the OCIRequest interface

func (ListAuthTokensRequest) RetryPolicy added in v1.6.0 

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

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

func (ListAuthTokensRequest) String added in v1.6.0 

func (request ListAuthTokensRequest) String() string

type ListAuthTokensResponse added in v1.6.0 

type ListAuthTokensResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListAuthTokensResponse wrapper for the ListAuthTokens operation

func (ListAuthTokensResponse) HTTPResponse added in v1.6.0 

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

HTTPResponse implements the OCIResponse interface

func (ListAuthTokensResponse) String added in v1.6.0 

func (response ListAuthTokensResponse) String() string

type ListAvailabilityDomainsRequest 

type ListAvailabilityDomainsRequest struct {

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

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

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

ListAvailabilityDomainsRequest wrapper for the ListAvailabilityDomains operation

func (ListAvailabilityDomainsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListAvailabilityDomainsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListAvailabilityDomainsRequest) String 

func (request ListAvailabilityDomainsRequest) String() string

type ListAvailabilityDomainsResponse 

type ListAvailabilityDomainsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListAvailabilityDomainsResponse wrapper for the ListAvailabilityDomains operation

func (ListAvailabilityDomainsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListAvailabilityDomainsResponse) String 

func (response ListAvailabilityDomainsResponse) String() string

type ListCompartmentsAccessLevelEnum 

type ListCompartmentsAccessLevelEnum string

ListCompartmentsAccessLevelEnum Enum with underlying type: string 

const (
	ListCompartmentsAccessLevelAny        ListCompartmentsAccessLevelEnum = "ANY"
	ListCompartmentsAccessLevelAccessible ListCompartmentsAccessLevelEnum = "ACCESSIBLE"
)

Set of constants representing the allowable values for ListCompartmentsAccessLevelEnum

func GetListCompartmentsAccessLevelEnumValues 

func GetListCompartmentsAccessLevelEnumValues() []ListCompartmentsAccessLevelEnum

GetListCompartmentsAccessLevelEnumValues Enumerates the set of values for ListCompartmentsAccessLevelEnum

type ListCompartmentsRequest 

type ListCompartmentsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`.
	// Setting this to `ACCESSIBLE` returns only those compartments for which the
	// user has INSPECT permissions directly or indirectly (permissions can be on a
	// resource in a subcompartment). For the compartments on which the user indirectly has
	// INSPECT permissions, a restricted set of fields is returned.
	// When set to `ANY` permissions are not checked.
	AccessLevel ListCompartmentsAccessLevelEnum `mandatory:"false" contributesTo:"query" name:"accessLevel" omitEmpty:"true"`

	// Default is false. Can only be set to true when performing
	// ListCompartments on the tenancy (root compartment).
	// When set to true, the hierarchy of compartments is traversed
	// and all compartments and subcompartments in the tenancy are
	// returned depending on the the setting of `accessLevel`.
	CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`

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

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

ListCompartmentsRequest wrapper for the ListCompartments operation

func (ListCompartmentsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListCompartmentsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListCompartmentsRequest) String 

func (request ListCompartmentsRequest) String() string

type ListCompartmentsResponse 

type ListCompartmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Compartment instances
	Items []Compartment `presentIn:"body"`

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

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

ListCompartmentsResponse wrapper for the ListCompartments operation

func (ListCompartmentsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListCompartmentsResponse) String 

func (response ListCompartmentsResponse) String() string

type ListCostTrackingTagsRequest 

type ListCostTrackingTagsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListCostTrackingTagsRequest wrapper for the ListCostTrackingTags operation

func (ListCostTrackingTagsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListCostTrackingTagsRequest) RetryPolicy 

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

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

func (ListCostTrackingTagsRequest) String 

func (request ListCostTrackingTagsRequest) String() string

type ListCostTrackingTagsResponse 

type ListCostTrackingTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Tag instances
	Items []Tag `presentIn:"body"`

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

ListCostTrackingTagsResponse wrapper for the ListCostTrackingTags operation

func (ListCostTrackingTagsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListCostTrackingTagsResponse) String 

func (response ListCostTrackingTagsResponse) String() string

type ListCustomerSecretKeysRequest 

type ListCustomerSecretKeysRequest struct {

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

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

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

ListCustomerSecretKeysRequest wrapper for the ListCustomerSecretKeys operation

func (ListCustomerSecretKeysRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListCustomerSecretKeysRequest) RetryPolicy added in v1.3.0 

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

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

func (ListCustomerSecretKeysRequest) String 

func (request ListCustomerSecretKeysRequest) String() string

type ListCustomerSecretKeysResponse 

type ListCustomerSecretKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListCustomerSecretKeysResponse wrapper for the ListCustomerSecretKeys operation

func (ListCustomerSecretKeysResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListCustomerSecretKeysResponse) String 

func (response ListCustomerSecretKeysResponse) String() string

type ListDynamicGroupsRequest added in v1.1.0 

type ListDynamicGroupsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListDynamicGroupsRequest wrapper for the ListDynamicGroups operation

func (ListDynamicGroupsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListDynamicGroupsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListDynamicGroupsRequest) String added in v1.1.0 

func (request ListDynamicGroupsRequest) String() string

type ListDynamicGroupsResponse added in v1.1.0 

type ListDynamicGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DynamicGroup instances
	Items []DynamicGroup `presentIn:"body"`

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

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

ListDynamicGroupsResponse wrapper for the ListDynamicGroups operation

func (ListDynamicGroupsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListDynamicGroupsResponse) String added in v1.1.0 

func (response ListDynamicGroupsResponse) String() string

type ListFaultDomainsRequest 

type ListFaultDomainsRequest struct {

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

	// The name of the availibilityDomain.
	AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

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

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

ListFaultDomainsRequest wrapper for the ListFaultDomains operation

func (ListFaultDomainsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListFaultDomainsRequest) RetryPolicy 

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

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

func (ListFaultDomainsRequest) String 

func (request ListFaultDomainsRequest) String() string

type ListFaultDomainsResponse 

type ListFaultDomainsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ListFaultDomainsResponse wrapper for the ListFaultDomains operation

func (ListFaultDomainsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListFaultDomainsResponse) String 

func (response ListFaultDomainsResponse) String() string

type ListGroupsRequest 

type ListGroupsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListGroupsRequest wrapper for the ListGroups operation

func (ListGroupsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListGroupsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListGroupsRequest) String 

func (request ListGroupsRequest) String() string

type ListGroupsResponse 

type ListGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Group instances
	Items []Group `presentIn:"body"`

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

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

ListGroupsResponse wrapper for the ListGroups operation

func (ListGroupsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListGroupsResponse) String 

func (response ListGroupsResponse) String() string

type ListIdentityProviderGroupsRequest 

type ListIdentityProviderGroupsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListIdentityProviderGroupsRequest wrapper for the ListIdentityProviderGroups operation

func (ListIdentityProviderGroupsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListIdentityProviderGroupsRequest) RetryPolicy 

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

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

func (ListIdentityProviderGroupsRequest) String 

func (request ListIdentityProviderGroupsRequest) String() string

type ListIdentityProviderGroupsResponse 

type ListIdentityProviderGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IdentityProviderGroupSummary instances
	Items []IdentityProviderGroupSummary `presentIn:"body"`

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

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

ListIdentityProviderGroupsResponse wrapper for the ListIdentityProviderGroups operation

func (ListIdentityProviderGroupsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListIdentityProviderGroupsResponse) String 

func (response ListIdentityProviderGroupsResponse) String() string

type ListIdentityProvidersProtocolEnum 

type ListIdentityProvidersProtocolEnum string

ListIdentityProvidersProtocolEnum Enum with underlying type: string 

const (
	ListIdentityProvidersProtocolSaml2 ListIdentityProvidersProtocolEnum = "SAML2"
)

Set of constants representing the allowable values for ListIdentityProvidersProtocolEnum

func GetListIdentityProvidersProtocolEnumValues 

func GetListIdentityProvidersProtocolEnumValues() []ListIdentityProvidersProtocolEnum

GetListIdentityProvidersProtocolEnumValues Enumerates the set of values for ListIdentityProvidersProtocolEnum

type ListIdentityProvidersRequest 

type ListIdentityProvidersRequest struct {

	// The protocol used for federation.
	Protocol ListIdentityProvidersProtocolEnum `mandatory:"true" contributesTo:"query" name:"protocol" omitEmpty:"true"`

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListIdentityProvidersRequest wrapper for the ListIdentityProviders operation

func (ListIdentityProvidersRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListIdentityProvidersRequest) RetryPolicy added in v1.3.0 

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

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

func (ListIdentityProvidersRequest) String 

func (request ListIdentityProvidersRequest) String() string

type ListIdentityProvidersResponse 

type ListIdentityProvidersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IdentityProvider instances
	Items []IdentityProvider `presentIn:"body"`

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

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

ListIdentityProvidersResponse wrapper for the ListIdentityProviders operation

func (ListIdentityProvidersResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListIdentityProvidersResponse) String 

func (response ListIdentityProvidersResponse) String() string

type ListIdpGroupMappingsRequest 

type ListIdpGroupMappingsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListIdpGroupMappingsRequest wrapper for the ListIdpGroupMappings operation

func (ListIdpGroupMappingsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListIdpGroupMappingsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListIdpGroupMappingsRequest) String 

func (request ListIdpGroupMappingsRequest) String() string

type ListIdpGroupMappingsResponse 

type ListIdpGroupMappingsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IdpGroupMapping instances
	Items []IdpGroupMapping `presentIn:"body"`

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

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

ListIdpGroupMappingsResponse wrapper for the ListIdpGroupMappings operation

func (ListIdpGroupMappingsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListIdpGroupMappingsResponse) String 

func (response ListIdpGroupMappingsResponse) String() string

type ListPoliciesRequest 

type ListPoliciesRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListPoliciesRequest wrapper for the ListPolicies operation

func (ListPoliciesRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListPoliciesRequest) RetryPolicy added in v1.3.0 

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

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

func (ListPoliciesRequest) String 

func (request ListPoliciesRequest) String() string

type ListPoliciesResponse 

type ListPoliciesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Policy instances
	Items []Policy `presentIn:"body"`

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

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

ListPoliciesResponse wrapper for the ListPolicies operation

func (ListPoliciesResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListPoliciesResponse) String 

func (response ListPoliciesResponse) String() string

type ListRegionSubscriptionsRequest 

type ListRegionSubscriptionsRequest struct {

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

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

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

ListRegionSubscriptionsRequest wrapper for the ListRegionSubscriptions operation

func (ListRegionSubscriptionsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListRegionSubscriptionsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListRegionSubscriptionsRequest) String 

func (request ListRegionSubscriptionsRequest) String() string

type ListRegionSubscriptionsResponse 

type ListRegionSubscriptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ListRegionSubscriptionsResponse wrapper for the ListRegionSubscriptions operation

func (ListRegionSubscriptionsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListRegionSubscriptionsResponse) String 

func (response ListRegionSubscriptionsResponse) String() string

type ListRegionsRequest 

type ListRegionsRequest struct {

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

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

ListRegionsRequest wrapper for the ListRegions operation

func (ListRegionsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListRegionsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListRegionsRequest) String 

func (request ListRegionsRequest) String() string

type ListRegionsResponse 

type ListRegionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ListRegionsResponse wrapper for the ListRegions operation

func (ListRegionsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListRegionsResponse) String 

func (response ListRegionsResponse) String() string

type ListSmtpCredentialsRequest added in v1.2.0 

type ListSmtpCredentialsRequest struct {

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

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

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

ListSmtpCredentialsRequest wrapper for the ListSmtpCredentials operation

func (ListSmtpCredentialsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListSmtpCredentialsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListSmtpCredentialsRequest) String added in v1.2.0 

func (request ListSmtpCredentialsRequest) String() string

type ListSmtpCredentialsResponse added in v1.2.0 

type ListSmtpCredentialsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListSmtpCredentialsResponse wrapper for the ListSmtpCredentials operation

func (ListSmtpCredentialsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListSmtpCredentialsResponse) String added in v1.2.0 

func (response ListSmtpCredentialsResponse) String() string

type ListSwiftPasswordsRequest 

type ListSwiftPasswordsRequest struct {

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

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

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

ListSwiftPasswordsRequest wrapper for the ListSwiftPasswords operation

func (ListSwiftPasswordsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListSwiftPasswordsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListSwiftPasswordsRequest) String 

func (request ListSwiftPasswordsRequest) String() string

type ListSwiftPasswordsResponse 

type ListSwiftPasswordsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListSwiftPasswordsResponse wrapper for the ListSwiftPasswords operation

func (ListSwiftPasswordsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListSwiftPasswordsResponse) String 

func (response ListSwiftPasswordsResponse) String() string

type ListTagNamespacesRequest added in v1.1.0 

type ListTagNamespacesRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this
	// parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
	IncludeSubcompartments *bool `mandatory:"false" contributesTo:"query" name:"includeSubcompartments"`

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

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

ListTagNamespacesRequest wrapper for the ListTagNamespaces operation

func (ListTagNamespacesRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListTagNamespacesRequest) RetryPolicy added in v1.3.0 

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

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

func (ListTagNamespacesRequest) String added in v1.1.0 

func (request ListTagNamespacesRequest) String() string

type ListTagNamespacesResponse added in v1.1.0 

type ListTagNamespacesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TagNamespaceSummary instances
	Items []TagNamespaceSummary `presentIn:"body"`

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

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

ListTagNamespacesResponse wrapper for the ListTagNamespaces operation

func (ListTagNamespacesResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListTagNamespacesResponse) String added in v1.1.0 

func (response ListTagNamespacesResponse) String() string

type ListTagsRequest added in v1.1.0 

type ListTagsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListTagsRequest wrapper for the ListTags operation

func (ListTagsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListTagsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListTagsRequest) String added in v1.1.0 

func (request ListTagsRequest) String() string

type ListTagsResponse added in v1.1.0 

type ListTagsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []TagSummary instances
	Items []TagSummary `presentIn:"body"`

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

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

ListTagsResponse wrapper for the ListTags operation

func (ListTagsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListTagsResponse) String added in v1.1.0 

func (response ListTagsResponse) String() string

type ListUserGroupMembershipsRequest 

type ListUserGroupMembershipsRequest struct {

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

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

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

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

ListUserGroupMembershipsRequest wrapper for the ListUserGroupMemberships operation

func (ListUserGroupMembershipsRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListUserGroupMembershipsRequest) RetryPolicy added in v1.3.0 

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

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

func (ListUserGroupMembershipsRequest) String 

func (request ListUserGroupMembershipsRequest) String() string

type ListUserGroupMembershipsResponse 

type ListUserGroupMembershipsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []UserGroupMembership instances
	Items []UserGroupMembership `presentIn:"body"`

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

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

ListUserGroupMembershipsResponse wrapper for the ListUserGroupMemberships operation

func (ListUserGroupMembershipsResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListUserGroupMembershipsResponse) String 

func (response ListUserGroupMembershipsResponse) String() string

type ListUsersRequest 

type ListUsersRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The id of the identity provider.
	IdentityProviderId *string `mandatory:"false" contributesTo:"query" name:"identityProviderId"`

	// The id of a user in the identity provider.
	ExternalIdentifier *string `mandatory:"false" contributesTo:"query" name:"externalIdentifier"`

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

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

ListUsersRequest wrapper for the ListUsers operation

func (ListUsersRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (ListUsersRequest) RetryPolicy added in v1.3.0 

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

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

func (ListUsersRequest) String 

func (request ListUsersRequest) String() string

type ListUsersResponse 

type ListUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []User instances
	Items []User `presentIn:"body"`

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

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

ListUsersResponse wrapper for the ListUsers operation

func (ListUsersResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (ListUsersResponse) String 

func (response ListUsersResponse) String() string

type ListWorkRequestsRequest 

type ListWorkRequestsRequest struct {

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

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The identifier of the resource the work request affects.
	ResourceIdentifier *string `mandatory:"false" contributesTo:"query" name:"resourceIdentifier"`

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

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

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

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

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestSummary instances
	Items []WorkRequestSummary `presentIn:"body"`

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

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type Policy 

type Policy struct {

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

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

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

	// An array of one or more policy statements written in the policy language.
	Statements []string `mandatory:"true" json:"statements"`

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

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Policy A document that specifies the type of access a group has to the resources in a compartment. For information about policies and other IAM Service components, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). If you're new to policies, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). The word "policy" is used by people in different ways:

  • An individual statement written in the policy language
  • A collection of statements in a single, named "policy" document (which has an Oracle Cloud ID (OCID) assigned to it)
  • The overall body of policies your organization uses to control access to resources

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.

func (Policy) String 

func (m Policy) String() string

type PolicyLifecycleStateEnum 

type PolicyLifecycleStateEnum string

PolicyLifecycleStateEnum Enum with underlying type: string 

const (
	PolicyLifecycleStateCreating PolicyLifecycleStateEnum = "CREATING"
	PolicyLifecycleStateActive   PolicyLifecycleStateEnum = "ACTIVE"
	PolicyLifecycleStateInactive PolicyLifecycleStateEnum = "INACTIVE"
	PolicyLifecycleStateDeleting PolicyLifecycleStateEnum = "DELETING"
	PolicyLifecycleStateDeleted  PolicyLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for PolicyLifecycleStateEnum

func GetPolicyLifecycleStateEnumValues 

func GetPolicyLifecycleStateEnumValues() []PolicyLifecycleStateEnum

GetPolicyLifecycleStateEnumValues Enumerates the set of values for PolicyLifecycleStateEnum

type Region 

type Region struct {

	// The key of the region.
	// Allowed values are:
	// - `PHX`
	// - `IAD`
	// - `FRA`
	// - `LHR`
	Key *string `mandatory:"false" json:"key"`

	// The name of the region.
	// Allowed values are:
	// - `us-phoenix-1`
	// - `us-ashburn-1`
	// - `eu-frankfurt-1`
	// - `uk-london-1`
	Name *string `mandatory:"false" json:"name"`
}

Region A localized geographic area, such as Phoenix, AZ. Oracle Cloud Infrastructure is hosted in regions and Availability Domains. A region is composed of several Availability Domains. An Availability Domain is one or more data centers located within a region. For more information, see Regions and Availability Domains (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

func (Region) String 

func (m Region) String() string

type RegionSubscription 

type RegionSubscription struct {

	// The region's key.
	// Allowed values are:
	// - `PHX`
	// - `IAD`
	// - `FRA`
	// - `LHR`
	RegionKey *string `mandatory:"true" json:"regionKey"`

	// The region's name.
	// Allowed values are:
	// - `us-phoenix-1`
	// - `us-ashburn-1`
	// - `eu-frankurt-1`
	// - `uk-london-1`
	RegionName *string `mandatory:"true" json:"regionName"`

	// The region subscription status.
	Status RegionSubscriptionStatusEnum `mandatory:"true" json:"status"`

	// Indicates if the region is the home region or not.
	IsHomeRegion *bool `mandatory:"true" json:"isHomeRegion"`
}

RegionSubscription An object that represents your tenancy's access to a particular region (i.e., a subscription), the status of that access, and whether that region is the home region. For more information, see Managing Regions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingregions.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

func (RegionSubscription) String 

func (m RegionSubscription) String() string

type RegionSubscriptionStatusEnum 

type RegionSubscriptionStatusEnum string

RegionSubscriptionStatusEnum Enum with underlying type: string 

const (
	RegionSubscriptionStatusReady      RegionSubscriptionStatusEnum = "READY"
	RegionSubscriptionStatusInProgress RegionSubscriptionStatusEnum = "IN_PROGRESS"
)

Set of constants representing the allowable values for RegionSubscriptionStatusEnum

func GetRegionSubscriptionStatusEnumValues 

func GetRegionSubscriptionStatusEnumValues() []RegionSubscriptionStatusEnum

GetRegionSubscriptionStatusEnumValues Enumerates the set of values for RegionSubscriptionStatusEnum

type RemoveUserFromGroupRequest 

type RemoveUserFromGroupRequest struct {

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

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

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

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

RemoveUserFromGroupRequest wrapper for the RemoveUserFromGroup operation

func (RemoveUserFromGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (RemoveUserFromGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (RemoveUserFromGroupRequest) String 

func (request RemoveUserFromGroupRequest) String() string

type RemoveUserFromGroupResponse 

type RemoveUserFromGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

RemoveUserFromGroupResponse wrapper for the RemoveUserFromGroup operation

func (RemoveUserFromGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (RemoveUserFromGroupResponse) String 

func (response RemoveUserFromGroupResponse) String() string

type ResetIdpScimClientRequest 

type ResetIdpScimClientRequest struct {

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

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

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

ResetIdpScimClientRequest wrapper for the ResetIdpScimClient operation

func (ResetIdpScimClientRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ResetIdpScimClientRequest) RetryPolicy 

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

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

func (ResetIdpScimClientRequest) String 

func (request ResetIdpScimClientRequest) String() string

type ResetIdpScimClientResponse 

type ResetIdpScimClientResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ResetIdpScimClientResponse wrapper for the ResetIdpScimClient operation

func (ResetIdpScimClientResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ResetIdpScimClientResponse) String 

func (response ResetIdpScimClientResponse) String() string

type Saml2IdentityProvider 

type Saml2IdentityProvider struct {

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

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

	// The name you assign to the `IdentityProvider` during creation. The name
	// must be unique across all `IdentityProvider` objects in the tenancy and
	// cannot be changed. This is the name federated users see when choosing
	// which identity provider to use when signing in to the Oracle Cloud Infrastructure
	// Console.
	Name *string `mandatory:"true" json:"name"`

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

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

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

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

	// The identity provider's signing certificate used by the IAM Service
	// to validate the SAML2 token.
	SigningCertificate *string `mandatory:"true" json:"signingCertificate"`

	// The URL to redirect federated users to for authentication with the
	// identity provider.
	RedirectUrl *string `mandatory:"true" json:"redirectUrl"`

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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 current state. After creating an `IdentityProvider`, make sure its
	// `lifecycleState` changes from CREATING to ACTIVE before using it.
	LifecycleState IdentityProviderLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

Saml2IdentityProvider A special type of IdentityProvider that supports the SAML 2.0 protocol. For more information, see Identity Providers and Federation (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).

func (Saml2IdentityProvider) GetCompartmentId 

func (m Saml2IdentityProvider) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (Saml2IdentityProvider) GetDefinedTags added in v1.1.0 

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

GetDefinedTags returns DefinedTags

func (Saml2IdentityProvider) GetDescription 

func (m Saml2IdentityProvider) GetDescription() *string

GetDescription returns Description

func (Saml2IdentityProvider) GetFreeformTags added in v1.1.0 

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

GetFreeformTags returns FreeformTags

func (Saml2IdentityProvider) GetId 

func (m Saml2IdentityProvider) GetId() *string

GetId returns Id

func (Saml2IdentityProvider) GetInactiveStatus 

func (m Saml2IdentityProvider) GetInactiveStatus() *int64

GetInactiveStatus returns InactiveStatus

func (Saml2IdentityProvider) GetLifecycleState 

func (m Saml2IdentityProvider) GetLifecycleState() IdentityProviderLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (Saml2IdentityProvider) GetName 

func (m Saml2IdentityProvider) GetName() *string

GetName returns Name

func (Saml2IdentityProvider) GetProductType 

func (m Saml2IdentityProvider) GetProductType() *string

GetProductType returns ProductType

func (Saml2IdentityProvider) GetTimeCreated 

func (m Saml2IdentityProvider) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (Saml2IdentityProvider) MarshalJSON 

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

MarshalJSON marshals to json representation

func (Saml2IdentityProvider) String 

func (m Saml2IdentityProvider) String() string

type ScimClientCredentials 

type ScimClientCredentials struct {

	// The client identifier.
	ClientId *string `mandatory:"false" json:"clientId"`

	// The client secret.
	ClientSecret *string `mandatory:"false" json:"clientSecret"`
}

ScimClientCredentials The OAuth2 client credentials.

func (ScimClientCredentials) String 

func (m ScimClientCredentials) String() string

type SmtpCredential added in v1.2.0 

type SmtpCredential struct {

	// The SMTP user name.
	Username *string `mandatory:"false" json:"username"`

	// The SMTP password.
	Password *string `mandatory:"false" json:"password"`

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

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

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

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

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

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

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

SmtpCredential Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. The SMTP credentials are used for SMTP authentication with the service. The credentials never expire. A user can have up to 2 SMTP credentials at a time. **Note:** The credential set is always an Oracle-generated SMTP user name and password pair; you cannot designate the SMTP user name or the SMTP password. For more information, see Managing User Credentials (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm#SMTP).

func (SmtpCredential) String added in v1.2.0 

func (m SmtpCredential) String() string

type SmtpCredentialLifecycleStateEnum added in v1.2.0 

type SmtpCredentialLifecycleStateEnum string

SmtpCredentialLifecycleStateEnum Enum with underlying type: string 

const (
	SmtpCredentialLifecycleStateCreating SmtpCredentialLifecycleStateEnum = "CREATING"
	SmtpCredentialLifecycleStateActive   SmtpCredentialLifecycleStateEnum = "ACTIVE"
	SmtpCredentialLifecycleStateInactive SmtpCredentialLifecycleStateEnum = "INACTIVE"
	SmtpCredentialLifecycleStateDeleting SmtpCredentialLifecycleStateEnum = "DELETING"
	SmtpCredentialLifecycleStateDeleted  SmtpCredentialLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SmtpCredentialLifecycleStateEnum

func GetSmtpCredentialLifecycleStateEnumValues added in v1.2.0 

func GetSmtpCredentialLifecycleStateEnumValues() []SmtpCredentialLifecycleStateEnum

GetSmtpCredentialLifecycleStateEnumValues Enumerates the set of values for SmtpCredentialLifecycleStateEnum

type SmtpCredentialSummary added in v1.2.0 

type SmtpCredentialSummary struct {

	// The SMTP user name.
	Username *string `mandatory:"false" json:"username"`

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

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

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

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

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

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

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

SmtpCredentialSummary As the name suggests, an `SmtpCredentialSummary` object contains information about an `SmtpCredential`. The SMTP credential is used for SMTP authentication with the Email Delivery Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/overview.htm).

func (SmtpCredentialSummary) String added in v1.2.0 

func (m SmtpCredentialSummary) String() string

type SmtpCredentialSummaryLifecycleStateEnum added in v1.2.0 

type SmtpCredentialSummaryLifecycleStateEnum string

SmtpCredentialSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	SmtpCredentialSummaryLifecycleStateCreating SmtpCredentialSummaryLifecycleStateEnum = "CREATING"
	SmtpCredentialSummaryLifecycleStateActive   SmtpCredentialSummaryLifecycleStateEnum = "ACTIVE"
	SmtpCredentialSummaryLifecycleStateInactive SmtpCredentialSummaryLifecycleStateEnum = "INACTIVE"
	SmtpCredentialSummaryLifecycleStateDeleting SmtpCredentialSummaryLifecycleStateEnum = "DELETING"
	SmtpCredentialSummaryLifecycleStateDeleted  SmtpCredentialSummaryLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SmtpCredentialSummaryLifecycleStateEnum

func GetSmtpCredentialSummaryLifecycleStateEnumValues added in v1.2.0 

func GetSmtpCredentialSummaryLifecycleStateEnumValues() []SmtpCredentialSummaryLifecycleStateEnum

GetSmtpCredentialSummaryLifecycleStateEnumValues Enumerates the set of values for SmtpCredentialSummaryLifecycleStateEnum

type SwiftPassword 

type SwiftPassword struct {

	// The Swift password. The value is available only in the response for `CreateSwiftPassword`, and not
	// for `ListSwiftPasswords` or `UpdateSwiftPassword`.
	Password *string `mandatory:"false" json:"password"`

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

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

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

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

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

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

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

SwiftPassword **Deprecated. Use AuthToken instead.** Swift is the OpenStack object storage service. A `SwiftPassword` is an Oracle-provided password for using a Swift client with the Object Storage Service. This password is associated with the user's Console login. Swift passwords never expire. A user can have up to two Swift passwords at a time. **Note:** The password is always an Oracle-generated string; you can't change it to a string of your choice. For more information, see Managing User Credentials (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingcredentials.htm).

func (SwiftPassword) String 

func (m SwiftPassword) String() string

type SwiftPasswordLifecycleStateEnum 

type SwiftPasswordLifecycleStateEnum string

SwiftPasswordLifecycleStateEnum Enum with underlying type: string 

const (
	SwiftPasswordLifecycleStateCreating SwiftPasswordLifecycleStateEnum = "CREATING"
	SwiftPasswordLifecycleStateActive   SwiftPasswordLifecycleStateEnum = "ACTIVE"
	SwiftPasswordLifecycleStateInactive SwiftPasswordLifecycleStateEnum = "INACTIVE"
	SwiftPasswordLifecycleStateDeleting SwiftPasswordLifecycleStateEnum = "DELETING"
	SwiftPasswordLifecycleStateDeleted  SwiftPasswordLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SwiftPasswordLifecycleStateEnum

func GetSwiftPasswordLifecycleStateEnumValues 

func GetSwiftPasswordLifecycleStateEnumValues() []SwiftPasswordLifecycleStateEnum

GetSwiftPasswordLifecycleStateEnumValues Enumerates the set of values for SwiftPasswordLifecycleStateEnum

type Tag added in v1.1.0 

type Tag struct {

	// The OCID of the compartment that contains the tag definition.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the namespace that contains the tag definition.
	TagNamespaceId *string `mandatory:"true" json:"tagNamespaceId"`

	// The name of the tag namespace that contains the tag definition.
	TagNamespaceName *string `mandatory:"true" json:"tagNamespaceName"`

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

	// The name of the tag. The name must be unique across all tags in the namespace and can't be changed.
	Name *string `mandatory:"true" json:"name"`

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

	// Indicates whether the tag is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
	IsRetired *bool `mandatory:"true" json:"isRetired"`

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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"`
}

Tag A tag definition that belongs to a specific tag namespace. "Defined tags" must be set up in your tenancy before you can apply them to resources. For more information, see Managing Tags and Tag Namespaces (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm).

func (Tag) String added in v1.1.0 

func (m Tag) String() string

type TagNamespace added in v1.1.0 

type TagNamespace struct {

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

	// The OCID of the compartment that contains the tag namespace.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

	// Whether the tag namespace is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
	IsRetired *bool `mandatory:"true" json:"isRetired"`

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

TagNamespace A managed container for defined tags. A tag namespace is unique in a tenancy. A tag namespace can't be deleted. For more information, see Managing Tags and Tag Namespaces (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm).

func (TagNamespace) String added in v1.1.0 

func (m TagNamespace) String() string

type TagNamespaceSummary added in v1.1.0 

type TagNamespaceSummary struct {

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

	// The OCID of the compartment that contains the tag namespace.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
	Name *string `mandatory:"false" json:"name"`

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Whether the tag namespace is retired.
	// For more information, see Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

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

TagNamespaceSummary A container for defined tags.

func (TagNamespaceSummary) String added in v1.1.0 

func (m TagNamespaceSummary) String() string

type TagSummary added in v1.1.0 

type TagSummary struct {

	// The OCID of the compartment that contains the tag definition.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

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

	// The name of the tag. The name must be unique across all tags in the tag namespace and can't be changed.
	Name *string `mandatory:"false" json:"name"`

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Whether the tag is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

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

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

TagSummary A tag definition that belongs to a specific tag namespace.

func (TagSummary) String added in v1.1.0 

func (m TagSummary) String() string

type Tenancy 

type Tenancy struct {

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

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

	// The description of the tenancy.
	Description *string `mandatory:"false" json:"description"`

	// The region key for the tenancy's home region. For more information about regions, see
	// Regions and Availability Domains (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm).
	// Allowed values are:
	// - `IAD`
	// - `PHX`
	// - `FRA`
	// - `LHR`
	HomeRegionKey *string `mandatory:"false" json:"homeRegionKey"`

	// 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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Tenancy The root compartment that contains all of your organization's compartments and other Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure, Oracle creates a tenancy for your company, which is a secure and isolated partition where you can create, organize, and administer your cloud resources. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

func (Tenancy) String 

func (m Tenancy) String() string

type UiPassword 

type UiPassword struct {

	// The user's password for the Console.
	Password *string `mandatory:"false" json:"password"`

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

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

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

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

UiPassword A text password that enables a user to sign in to the Console, the user interface for interacting with Oracle Cloud Infrastructure. For more information about user credentials, see User Credentials (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/usercredentials.htm).

func (UiPassword) String 

func (m UiPassword) String() string

type UiPasswordLifecycleStateEnum 

type UiPasswordLifecycleStateEnum string

UiPasswordLifecycleStateEnum Enum with underlying type: string 

const (
	UiPasswordLifecycleStateCreating UiPasswordLifecycleStateEnum = "CREATING"
	UiPasswordLifecycleStateActive   UiPasswordLifecycleStateEnum = "ACTIVE"
	UiPasswordLifecycleStateInactive UiPasswordLifecycleStateEnum = "INACTIVE"
	UiPasswordLifecycleStateDeleting UiPasswordLifecycleStateEnum = "DELETING"
	UiPasswordLifecycleStateDeleted  UiPasswordLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UiPasswordLifecycleStateEnum

func GetUiPasswordLifecycleStateEnumValues 

func GetUiPasswordLifecycleStateEnumValues() []UiPasswordLifecycleStateEnum

GetUiPasswordLifecycleStateEnumValues Enumerates the set of values for UiPasswordLifecycleStateEnum

type UpdateAuthTokenDetails added in v1.6.0 

type UpdateAuthTokenDetails struct {

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

UpdateAuthTokenDetails The representation of UpdateAuthTokenDetails

func (UpdateAuthTokenDetails) String added in v1.6.0 

func (m UpdateAuthTokenDetails) String() string

type UpdateAuthTokenRequest added in v1.6.0 

type UpdateAuthTokenRequest struct {

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

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

	// Request object for updating an auth token.
	UpdateAuthTokenDetails `contributesTo:"body"`

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

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

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

UpdateAuthTokenRequest wrapper for the UpdateAuthToken operation

func (UpdateAuthTokenRequest) HTTPRequest added in v1.6.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateAuthTokenRequest) RetryPolicy added in v1.6.0 

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

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

func (UpdateAuthTokenRequest) String added in v1.6.0 

func (request UpdateAuthTokenRequest) String() string

type UpdateAuthTokenResponse added in v1.6.0 

type UpdateAuthTokenResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateAuthTokenResponse wrapper for the UpdateAuthToken operation

func (UpdateAuthTokenResponse) HTTPResponse added in v1.6.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateAuthTokenResponse) String added in v1.6.0 

func (response UpdateAuthTokenResponse) String() string

type UpdateCompartmentDetails 

type UpdateCompartmentDetails struct {

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateCompartmentDetails The representation of UpdateCompartmentDetails

func (UpdateCompartmentDetails) String 

func (m UpdateCompartmentDetails) String() string

type UpdateCompartmentRequest 

type UpdateCompartmentRequest struct {

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

	// Request object for updating a compartment.
	UpdateCompartmentDetails `contributesTo:"body"`

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

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

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

UpdateCompartmentRequest wrapper for the UpdateCompartment operation

func (UpdateCompartmentRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateCompartmentRequest) RetryPolicy added in v1.3.0 

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

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

func (UpdateCompartmentRequest) String 

func (request UpdateCompartmentRequest) String() string

type UpdateCompartmentResponse 

type UpdateCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateCompartmentResponse wrapper for the UpdateCompartment operation

func (UpdateCompartmentResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateCompartmentResponse) String 

func (response UpdateCompartmentResponse) String() string

type UpdateCustomerSecretKeyDetails 

type UpdateCustomerSecretKeyDetails struct {

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

UpdateCustomerSecretKeyDetails The representation of UpdateCustomerSecretKeyDetails

func (UpdateCustomerSecretKeyDetails) String 

func (m UpdateCustomerSecretKeyDetails) String() string

type UpdateCustomerSecretKeyRequest 

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

	// Request object for updating a secret key.
	UpdateCustomerSecretKeyDetails `contributesTo:"body"`

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

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

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

UpdateCustomerSecretKeyRequest wrapper for the UpdateCustomerSecretKey operation

func (UpdateCustomerSecretKeyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateCustomerSecretKeyRequest) RetryPolicy added in v1.3.0 

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

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

func (UpdateCustomerSecretKeyRequest) String 

func (request UpdateCustomerSecretKeyRequest) String() string

type UpdateCustomerSecretKeyResponse 

type UpdateCustomerSecretKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateCustomerSecretKeyResponse wrapper for the UpdateCustomerSecretKey operation

func (UpdateCustomerSecretKeyResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateCustomerSecretKeyResponse) String 

func (response UpdateCustomerSecretKeyResponse) String() string

type UpdateDynamicGroupDetails added in v1.1.0 

type UpdateDynamicGroupDetails struct {

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

	// The matching rule to dynamically match an instance certificate to this dynamic group.
	// For rule syntax, see Managing Dynamic Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm).
	MatchingRule *string `mandatory:"false" json:"matchingRule"`
}

UpdateDynamicGroupDetails Properties for updating a dynamic group.

func (UpdateDynamicGroupDetails) String added in v1.1.0 

func (m UpdateDynamicGroupDetails) String() string

type UpdateDynamicGroupRequest added in v1.1.0 

type UpdateDynamicGroupRequest struct {

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

	// Request object for updating an dynamic group.
	UpdateDynamicGroupDetails `contributesTo:"body"`

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

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

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

UpdateDynamicGroupRequest wrapper for the UpdateDynamicGroup operation

func (UpdateDynamicGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateDynamicGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (UpdateDynamicGroupRequest) String added in v1.1.0 

func (request UpdateDynamicGroupRequest) String() string

type UpdateDynamicGroupResponse added in v1.1.0 

type UpdateDynamicGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateDynamicGroupResponse wrapper for the UpdateDynamicGroup operation

func (UpdateDynamicGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDynamicGroupResponse) String added in v1.1.0 

func (response UpdateDynamicGroupResponse) String() string

type UpdateGroupDetails 

type UpdateGroupDetails struct {

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateGroupDetails The representation of UpdateGroupDetails

func (UpdateGroupDetails) String 

func (m UpdateGroupDetails) String() string

type UpdateGroupRequest 

type UpdateGroupRequest struct {

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

	// Request object for updating a group.
	UpdateGroupDetails `contributesTo:"body"`

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

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

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

UpdateGroupRequest wrapper for the UpdateGroup operation

func (UpdateGroupRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateGroupRequest) RetryPolicy added in v1.3.0 

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

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

func (UpdateGroupRequest) String 

func (request UpdateGroupRequest) String() string

type UpdateGroupResponse 

type UpdateGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateGroupResponse wrapper for the UpdateGroup operation

func (UpdateGroupResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateGroupResponse) String 

func (response UpdateGroupResponse) String() string

type UpdateIdentityProviderDetails 

type UpdateIdentityProviderDetails interface {

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

UpdateIdentityProviderDetails The representation of UpdateIdentityProviderDetails

type UpdateIdentityProviderRequest 

type UpdateIdentityProviderRequest struct {

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

	// Request object for updating a identity provider.
	UpdateIdentityProviderDetails `contributesTo:"body"`

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

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

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

UpdateIdentityProviderRequest wrapper for the UpdateIdentityProvider operation

func (UpdateIdentityProviderRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateIdentityProviderRequest) RetryPolicy added in v1.3.0 

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

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

func (UpdateIdentityProviderRequest) String 

func (request UpdateIdentityProviderRequest) String() string

type UpdateIdentityProviderResponse 

type UpdateIdentityProviderResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateIdentityProviderResponse wrapper for the UpdateIdentityProvider operation

func (UpdateIdentityProviderResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateIdentityProviderResponse) String 

func (response UpdateIdentityProviderResponse) String() string

type UpdateIdpGroupMappingDetails 

type UpdateIdpGroupMappingDetails struct {

	// The idp group name.
	IdpGroupName *string `mandatory:"false" json:"idpGroupName"`

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

UpdateIdpGroupMappingDetails The representation of UpdateIdpGroupMappingDetails

func (UpdateIdpGroupMappingDetails) String 

func (m UpdateIdpGroupMappingDetails) String() string

type UpdateIdpGroupMappingRequest 

type UpdateIdpGroupMappingRequest struct {

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

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

	// Request object for updating an identity provider group mapping
	UpdateIdpGroupMappingDetails `contributesTo:"body"`

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

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

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

UpdateIdpGroupMappingRequest wrapper for the UpdateIdpGroupMapping operation

func (UpdateIdpGroupMappingRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdateIdpGroupMappingRequest) RetryPolicy added in v1.3.0 

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

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

func (UpdateIdpGroupMappingRequest) String 

func (request UpdateIdpGroupMappingRequest) String() string

type UpdateIdpGroupMappingResponse 

type UpdateIdpGroupMappingResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateIdpGroupMappingResponse wrapper for the UpdateIdpGroupMapping operation

func (UpdateIdpGroupMappingResponse) HTTPResponse added in v1.3.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateIdpGroupMappingResponse) String 

func (response UpdateIdpGroupMappingResponse) String() string

type UpdatePolicyDetails 

type UpdatePolicyDetails struct {

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdatePolicyDetails The representation of UpdatePolicyDetails

func (UpdatePolicyDetails) String 

func (m UpdatePolicyDetails) String() string

type UpdatePolicyRequest 

type UpdatePolicyRequest struct {

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

	// Request object for updating a policy.
	UpdatePolicyDetails `contributesTo:"body"`

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

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

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

UpdatePolicyRequest wrapper for the UpdatePolicy operation

func (UpdatePolicyRequest) HTTPRequest added in v1.3.0 

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

HTTPRequest implements the OCIRequest interface

func (UpdatePolicyRequest) RetryPolicy added in v1.3.0 

func (request UpdatePolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdatePolicyRequest) String 

func (request UpdatePolicyRequest) String() string

type UpdatePolicyResponse 

type UpdatePolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Policy instance
	Policy `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdatePolicyResponse wrapper for the UpdatePolicy operation

func (UpdatePolicyResponse) HTTPResponse added in v1.3.0 

func (response UpdatePolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdatePolicyResponse) String 

func (response UpdatePolicyResponse) String() string

type UpdateSaml2IdentityProviderDetails 

type UpdateSaml2IdentityProviderDetails struct {

	// The description you assign to the `IdentityProvider`. Does not have to
	// be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The URL for retrieving the identity provider's metadata,
	// which contains information required for federating.
	MetadataUrl *string `mandatory:"false" json:"metadataUrl"`

	// The XML that contains the information required for federating.
	Metadata *string `mandatory:"false" json:"metadata"`

	// Extra name value pairs associated with this identity provider.
	// Example: `{"clientId": "app_sf3kdjf3"}`
	FreeformAttributes map[string]string `mandatory:"false" json:"freeformAttributes"`
}

UpdateSaml2IdentityProviderDetails The representation of UpdateSaml2IdentityProviderDetails

func (UpdateSaml2IdentityProviderDetails) GetDefinedTags added in v1.1.0 

func (m UpdateSaml2IdentityProviderDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateSaml2IdentityProviderDetails) GetDescription 

func (m UpdateSaml2IdentityProviderDetails) GetDescription() *string

GetDescription returns Description

func (UpdateSaml2IdentityProviderDetails) GetFreeformTags added in v1.1.0 

func (m UpdateSaml2IdentityProviderDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateSaml2IdentityProviderDetails) MarshalJSON 

func (m UpdateSaml2IdentityProviderDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateSaml2IdentityProviderDetails) String 

func (m UpdateSaml2IdentityProviderDetails) String() string

type UpdateSmtpCredentialDetails added in v1.2.0 

type UpdateSmtpCredentialDetails struct {

	// The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`
}

UpdateSmtpCredentialDetails The representation of UpdateSmtpCredentialDetails

func (UpdateSmtpCredentialDetails) String added in v1.2.0 

func (m UpdateSmtpCredentialDetails) String() string

type UpdateSmtpCredentialRequest added in v1.2.0 

type UpdateSmtpCredentialRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the SMTP credential.
	SmtpCredentialId *string `mandatory:"true" contributesTo:"path" name:"smtpCredentialId"`

	// Request object for updating a SMTP credential.
	UpdateSmtpCredentialDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateSmtpCredentialRequest wrapper for the UpdateSmtpCredential operation

func (UpdateSmtpCredentialRequest) HTTPRequest added in v1.3.0 

func (request UpdateSmtpCredentialRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSmtpCredentialRequest) RetryPolicy added in v1.3.0 

func (request UpdateSmtpCredentialRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSmtpCredentialRequest) String added in v1.2.0 

func (request UpdateSmtpCredentialRequest) String() string

type UpdateSmtpCredentialResponse added in v1.2.0 

type UpdateSmtpCredentialResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SmtpCredentialSummary instance
	SmtpCredentialSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateSmtpCredentialResponse wrapper for the UpdateSmtpCredential operation

func (UpdateSmtpCredentialResponse) HTTPResponse added in v1.3.0 

func (response UpdateSmtpCredentialResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSmtpCredentialResponse) String added in v1.2.0 

func (response UpdateSmtpCredentialResponse) String() string

type UpdateStateDetails 

type UpdateStateDetails struct {

	// Update state to blocked or unblocked. Only "false" is supported (for changing the state to unblocked).
	Blocked *bool `mandatory:"false" json:"blocked"`
}

UpdateStateDetails The representation of UpdateStateDetails

func (UpdateStateDetails) String 

func (m UpdateStateDetails) String() string

type UpdateSwiftPasswordDetails 

type UpdateSwiftPasswordDetails struct {

	// The description you assign to the Swift password. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`
}

UpdateSwiftPasswordDetails The representation of UpdateSwiftPasswordDetails

func (UpdateSwiftPasswordDetails) String 

func (m UpdateSwiftPasswordDetails) String() string

type UpdateSwiftPasswordRequest 

type UpdateSwiftPasswordRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// The OCID of the Swift password.
	SwiftPasswordId *string `mandatory:"true" contributesTo:"path" name:"swiftPasswordId"`

	// Request object for updating a Swift password.
	UpdateSwiftPasswordDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateSwiftPasswordRequest wrapper for the UpdateSwiftPassword operation

func (UpdateSwiftPasswordRequest) HTTPRequest added in v1.3.0 

func (request UpdateSwiftPasswordRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSwiftPasswordRequest) RetryPolicy added in v1.3.0 

func (request UpdateSwiftPasswordRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSwiftPasswordRequest) String 

func (request UpdateSwiftPasswordRequest) String() string

type UpdateSwiftPasswordResponse 

type UpdateSwiftPasswordResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SwiftPassword instance
	SwiftPassword `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateSwiftPasswordResponse wrapper for the UpdateSwiftPassword operation

func (UpdateSwiftPasswordResponse) HTTPResponse added in v1.3.0 

func (response UpdateSwiftPasswordResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSwiftPasswordResponse) String 

func (response UpdateSwiftPasswordResponse) String() string

type UpdateTagDetails added in v1.1.0 

type UpdateTagDetails struct {

	// The description you assign to the tag during creation.
	Description *string `mandatory:"false" json:"description"`

	// Whether the tag is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.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"`
}

UpdateTagDetails The representation of UpdateTagDetails

func (UpdateTagDetails) String added in v1.1.0 

func (m UpdateTagDetails) String() string

type UpdateTagNamespaceDetails added in v1.1.0 

type UpdateTagNamespaceDetails struct {

	// The description you assign to the tag namespace.
	Description *string `mandatory:"false" json:"description"`

	// Whether the tag namespace is retired.
	// See Retiring Key Definitions and Namespace Definitions (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/taggingoverview.htm#Retiring).
	IsRetired *bool `mandatory:"false" json:"isRetired"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateTagNamespaceDetails The representation of UpdateTagNamespaceDetails

func (UpdateTagNamespaceDetails) String added in v1.1.0 

func (m UpdateTagNamespaceDetails) String() string

type UpdateTagNamespaceRequest added in v1.1.0 

type UpdateTagNamespaceRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// Request object for updating a namespace.
	UpdateTagNamespaceDetails `contributesTo:"body"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateTagNamespaceRequest wrapper for the UpdateTagNamespace operation

func (UpdateTagNamespaceRequest) HTTPRequest added in v1.3.0 

func (request UpdateTagNamespaceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTagNamespaceRequest) RetryPolicy added in v1.3.0 

func (request UpdateTagNamespaceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTagNamespaceRequest) String added in v1.1.0 

func (request UpdateTagNamespaceRequest) String() string

type UpdateTagNamespaceResponse added in v1.1.0 

type UpdateTagNamespaceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The TagNamespace instance
	TagNamespace `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateTagNamespaceResponse wrapper for the UpdateTagNamespace operation

func (UpdateTagNamespaceResponse) HTTPResponse added in v1.3.0 

func (response UpdateTagNamespaceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTagNamespaceResponse) String added in v1.1.0 

func (response UpdateTagNamespaceResponse) String() string

type UpdateTagRequest added in v1.1.0 

type UpdateTagRequest struct {

	// The OCID of the tag namespace.
	TagNamespaceId *string `mandatory:"true" contributesTo:"path" name:"tagNamespaceId"`

	// The name of the tag.
	TagName *string `mandatory:"true" contributesTo:"path" name:"tagName"`

	// Request object for updating a tag.
	UpdateTagDetails `contributesTo:"body"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateTagRequest wrapper for the UpdateTag operation

func (UpdateTagRequest) HTTPRequest added in v1.3.0 

func (request UpdateTagRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTagRequest) RetryPolicy added in v1.3.0 

func (request UpdateTagRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTagRequest) String added in v1.1.0 

func (request UpdateTagRequest) String() string

type UpdateTagResponse added in v1.1.0 

type UpdateTagResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Tag instance
	Tag `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateTagResponse wrapper for the UpdateTag operation

func (UpdateTagResponse) HTTPResponse added in v1.3.0 

func (response UpdateTagResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTagResponse) String added in v1.1.0 

func (response UpdateTagResponse) String() string

type UpdateUserCapabilitiesDetails 

type UpdateUserCapabilitiesDetails struct {

	// Indicates if the user can log in to the console.
	CanUseConsolePassword *bool `mandatory:"false" json:"canUseConsolePassword"`

	// Indicates if the user can use API keys.
	CanUseApiKeys *bool `mandatory:"false" json:"canUseApiKeys"`

	// Indicates if the user can use SWIFT passwords / auth tokens.
	CanUseAuthTokens *bool `mandatory:"false" json:"canUseAuthTokens"`

	// Indicates if the user can use SMTP passwords.
	CanUseSmtpCredentials *bool `mandatory:"false" json:"canUseSmtpCredentials"`

	// Indicates if the user can use SigV4 symmetric keys.
	CanUseCustomerSecretKeys *bool `mandatory:"false" json:"canUseCustomerSecretKeys"`
}

UpdateUserCapabilitiesDetails The representation of UpdateUserCapabilitiesDetails

func (UpdateUserCapabilitiesDetails) String 

func (m UpdateUserCapabilitiesDetails) String() string

type UpdateUserCapabilitiesRequest 

type UpdateUserCapabilitiesRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for updating user capabilities.
	UpdateUserCapabilitiesDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateUserCapabilitiesRequest wrapper for the UpdateUserCapabilities operation

func (UpdateUserCapabilitiesRequest) HTTPRequest 

func (request UpdateUserCapabilitiesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUserCapabilitiesRequest) RetryPolicy 

func (request UpdateUserCapabilitiesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateUserCapabilitiesRequest) String 

func (request UpdateUserCapabilitiesRequest) String() string

type UpdateUserCapabilitiesResponse 

type UpdateUserCapabilitiesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateUserCapabilitiesResponse wrapper for the UpdateUserCapabilities operation

func (UpdateUserCapabilitiesResponse) HTTPResponse 

func (response UpdateUserCapabilitiesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateUserCapabilitiesResponse) String 

func (response UpdateUserCapabilitiesResponse) String() string

type UpdateUserDetails 

type UpdateUserDetails struct {

	// The description you assign to the user. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateUserDetails The representation of UpdateUserDetails

func (UpdateUserDetails) String 

func (m UpdateUserDetails) String() string

type UpdateUserRequest 

type UpdateUserRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for updating a user.
	UpdateUserDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateUserRequest wrapper for the UpdateUser operation

func (UpdateUserRequest) HTTPRequest added in v1.3.0 

func (request UpdateUserRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUserRequest) RetryPolicy added in v1.3.0 

func (request UpdateUserRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateUserRequest) String 

func (request UpdateUserRequest) String() string

type UpdateUserResponse 

type UpdateUserResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateUserResponse wrapper for the UpdateUser operation

func (UpdateUserResponse) HTTPResponse added in v1.3.0 

func (response UpdateUserResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateUserResponse) String 

func (response UpdateUserResponse) String() string

type UpdateUserStateRequest 

type UpdateUserStateRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for updating a user state.
	UpdateStateDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateUserStateRequest wrapper for the UpdateUserState operation

func (UpdateUserStateRequest) HTTPRequest added in v1.3.0 

func (request UpdateUserStateRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUserStateRequest) RetryPolicy added in v1.3.0 

func (request UpdateUserStateRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateUserStateRequest) String 

func (request UpdateUserStateRequest) String() string

type UpdateUserStateResponse 

type UpdateUserStateResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The User instance
	User `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateUserStateResponse wrapper for the UpdateUserState operation

func (UpdateUserStateResponse) HTTPResponse added in v1.3.0 

func (response UpdateUserStateResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateUserStateResponse) String 

func (response UpdateUserStateResponse) String() string

type UploadApiKeyRequest 

type UploadApiKeyRequest struct {

	// The OCID of the user.
	UserId *string `mandatory:"true" contributesTo:"path" name:"userId"`

	// Request object for uploading an API key for a user.
	CreateApiKeyDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UploadApiKeyRequest wrapper for the UploadApiKey operation

func (UploadApiKeyRequest) HTTPRequest added in v1.3.0 

func (request UploadApiKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UploadApiKeyRequest) RetryPolicy added in v1.3.0 

func (request UploadApiKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UploadApiKeyRequest) String 

func (request UploadApiKeyRequest) String() string

type UploadApiKeyResponse 

type UploadApiKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ApiKey instance
	ApiKey `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UploadApiKeyResponse wrapper for the UploadApiKey operation

func (UploadApiKeyResponse) HTTPResponse added in v1.3.0 

func (response UploadApiKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UploadApiKeyResponse) String 

func (response UploadApiKeyResponse) String() string

type User 

type User struct {

	// The OCID of the user.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the user.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name you assign to the user during creation. This is the user's login for the Console.
	// The name must be unique across all users in the tenancy and cannot be changed.
	Name *string `mandatory:"true" json:"name"`

	// The description you assign to the user. Does not have to be unique, and it's changeable.
	Description *string `mandatory:"true" json:"description"`

	// Date and time the user was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The user's current state. After creating a user, make sure its `lifecycleState` changes from CREATING to
	// ACTIVE before using it.
	LifecycleState UserLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID of the `IdentityProvider` this user belongs to.
	IdentityProviderId *string `mandatory:"false" json:"identityProviderId"`

	// Identifier of the user in the identity provider
	ExternalIdentifier *string `mandatory:"false" json:"externalIdentifier"`

	// Returned only if the user's `lifecycleState` is INACTIVE. A 16-bit value showing the reason why the user
	// is inactive:
	// - bit 0: SUSPENDED (reserved for future use)
	// - bit 1: DISABLED (reserved for future use)
	// - bit 2: BLOCKED (the user has exceeded the maximum number of failed login attempts for the Console)
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Properties indicating how the user is allowed to authenticate.
	Capabilities *UserCapabilities `mandatory:"false" json:"capabilities"`
}

User An individual employee or system that needs to manage or use your company's Oracle Cloud Infrastructure resources. Users might need to launch instances, manage remote disks, work with your cloud network, etc. Users have one or more IAM Service credentials (ApiKey, UIPassword, SwiftPassword and AuthToken). For more information, see User Credentials (https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/usercredentials.htm)). End users of your application are not typically IAM Service users. For conceptual information about users and other IAM Service components, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). These users are created directly within the Oracle Cloud Infrastructure system, via the IAM service. They are different from *federated users*, who authenticate themselves to the Oracle Cloud Infrastructure Console via an identity provider. For more information, see Identity Providers and Federation (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

func (User) String 

func (m User) String() string

type UserCapabilities 

type UserCapabilities struct {

	// Indicates if the user can log in to the console.
	CanUseConsolePassword *bool `mandatory:"false" json:"canUseConsolePassword"`

	// Indicates if the user can use API keys.
	CanUseApiKeys *bool `mandatory:"false" json:"canUseApiKeys"`

	// Indicates if the user can use SWIFT passwords / auth tokens.
	CanUseAuthTokens *bool `mandatory:"false" json:"canUseAuthTokens"`

	// Indicates if the user can use SMTP passwords.
	CanUseSmtpCredentials *bool `mandatory:"false" json:"canUseSmtpCredentials"`

	// Indicates if the user can use SigV4 symmetric keys.
	CanUseCustomerSecretKeys *bool `mandatory:"false" json:"canUseCustomerSecretKeys"`
}

UserCapabilities Properties indicating how the user is allowed to authenticate.

func (UserCapabilities) String 

func (m UserCapabilities) String() string

type UserGroupMembership 

type UserGroupMembership struct {

	// The OCID of the membership.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the tenancy containing the user, group, and membership object.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the group.
	GroupId *string `mandatory:"true" json:"groupId"`

	// The OCID of the user.
	UserId *string `mandatory:"true" json:"userId"`

	// Date and time the membership was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The membership's current state.  After creating a membership object, make sure its `lifecycleState` changes
	// from CREATING to ACTIVE before using it.
	LifecycleState UserGroupMembershipLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The detailed status of INACTIVE lifecycleState.
	InactiveStatus *int64 `mandatory:"false" json:"inactiveStatus"`
}

UserGroupMembership An object that represents the membership of a user in a group. When you add a user to a group, the result is a `UserGroupMembership` with its own OCID. To remove a user from a group, you delete the `UserGroupMembership` object.

func (UserGroupMembership) String 

func (m UserGroupMembership) String() string

type UserGroupMembershipLifecycleStateEnum 

type UserGroupMembershipLifecycleStateEnum string

UserGroupMembershipLifecycleStateEnum Enum with underlying type: string 

const (
	UserGroupMembershipLifecycleStateCreating UserGroupMembershipLifecycleStateEnum = "CREATING"
	UserGroupMembershipLifecycleStateActive   UserGroupMembershipLifecycleStateEnum = "ACTIVE"
	UserGroupMembershipLifecycleStateInactive UserGroupMembershipLifecycleStateEnum = "INACTIVE"
	UserGroupMembershipLifecycleStateDeleting UserGroupMembershipLifecycleStateEnum = "DELETING"
	UserGroupMembershipLifecycleStateDeleted  UserGroupMembershipLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UserGroupMembershipLifecycleStateEnum

func GetUserGroupMembershipLifecycleStateEnumValues 

func GetUserGroupMembershipLifecycleStateEnumValues() []UserGroupMembershipLifecycleStateEnum

GetUserGroupMembershipLifecycleStateEnumValues Enumerates the set of values for UserGroupMembershipLifecycleStateEnum

type UserLifecycleStateEnum 

type UserLifecycleStateEnum string

UserLifecycleStateEnum Enum with underlying type: string 

const (
	UserLifecycleStateCreating UserLifecycleStateEnum = "CREATING"
	UserLifecycleStateActive   UserLifecycleStateEnum = "ACTIVE"
	UserLifecycleStateInactive UserLifecycleStateEnum = "INACTIVE"
	UserLifecycleStateDeleting UserLifecycleStateEnum = "DELETING"
	UserLifecycleStateDeleted  UserLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for UserLifecycleStateEnum

func GetUserLifecycleStateEnumValues 

func GetUserLifecycleStateEnumValues() []UserLifecycleStateEnum

GetUserLifecycleStateEnumValues Enumerates the set of values for UserLifecycleStateEnum

type WorkRequest 

type WorkRequest struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// An enum-like description of the type of work the work request is doing.
	OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment that contains the work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"false" json:"resources"`

	// The errors for work request.
	Errors []WorkRequestError `mandatory:"false" json:"errors"`

	// The logs for work request.
	Logs []WorkRequestLogEntry `mandatory:"false" json:"logs"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
}

WorkRequest The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.

func (WorkRequest) String 

func (m WorkRequest) String() string

type WorkRequestError 

type WorkRequestError struct {

	// A machine-usable code for the error that occured.
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the error happened, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

WorkRequestError The error entity.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

type WorkRequestLogEntry 

type WorkRequestLogEntry struct {

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// Date and time the log was written, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}

WorkRequestLogEntry The log entity.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

type WorkRequestOperationTypeEnum 

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string 

const (
	WorkRequestOperationTypeCompartment WorkRequestOperationTypeEnum = "DELETE_COMPARTMENT"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetWorkRequestOperationTypeEnumValues 

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource 

type WorkRequestResource struct {

	// The resource identifier the work request affects.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The resource type the work request is affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource was affected by the work tracked by the work request.
	ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

	// The URI path that the user can do a GET on to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`
}

WorkRequestResource The resource entity.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum 

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string 

const (
	WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
	WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
	WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
	WorkRequestResourceActionTypeRelated    WorkRequestResourceActionTypeEnum = "RELATED"
	WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues 

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum 

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string 

const (
	WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
	WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
	WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetWorkRequestStatusEnumValues 

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary 

type WorkRequestSummary struct {

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

	// An enum-like description of the type of work the work request is doing.
	OperationType WorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The current status of the work request.
	Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the compartment that contains the work request.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The resources this work request affects.
	Resources []WorkRequestResource `mandatory:"false" json:"resources"`

	// The errors for work request.
	Errors []WorkRequestError `mandatory:"false" json:"errors"`

	// Date and time the work was accepted, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`

	// Date and time the work started, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// Date and time the work completed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// How much progress the operation has made.
	PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
}

WorkRequestSummary The work request summary. Tracks the status of the asynchronous operation.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

type WorkRequestSummaryOperationTypeEnum 

type WorkRequestSummaryOperationTypeEnum string

WorkRequestSummaryOperationTypeEnum Enum with underlying type: string 

const (
	WorkRequestSummaryOperationTypeCompartment WorkRequestSummaryOperationTypeEnum = "DELETE_COMPARTMENT"
)

Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum

func GetWorkRequestSummaryOperationTypeEnumValues 

func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum

GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum

type WorkRequestSummaryStatusEnum 

type WorkRequestSummaryStatusEnum string

WorkRequestSummaryStatusEnum Enum with underlying type: string 

const (
	WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
	WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
	WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
	WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
	WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
	WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

func GetWorkRequestSummaryStatusEnumValues 

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.