Class: OCI::Identity::IdentityClient
- Inherits:
-
Object
- Object
- OCI::Identity::IdentityClient
- Defined in:
- lib/oci/identity/identity_client.rb
Overview
APIs for managing users, groups, compartments, and policies.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#activate_mfa_totp_device(user_id, mfa_totp_device_id, mfa_totp_token, opts = {}) ⇒ Response
Activates the specified MFA TOTP device for the user.
-
#add_user_to_group(add_user_to_group_details, opts = {}) ⇒ Response
Adds the specified user to the specified group and returns a ‘UserGroupMembership` object with its own OCID.
-
#change_tag_namespace_compartment(tag_namespace_id, change_tag_namespace_compartment_detail, opts = {}) ⇒ Response
Moves the specified tag namespace to the specified compartment within the same tenancy.
-
#create_auth_token(create_auth_token_details, user_id, opts = {}) ⇒ Response
Creates a new auth token for the specified user.
-
#create_compartment(create_compartment_details, opts = {}) ⇒ Response
Creates a new compartment in the specified compartment.
-
#create_customer_secret_key(create_customer_secret_key_details, user_id, opts = {}) ⇒ Response
Creates a new secret key for the specified user.
-
#create_dynamic_group(create_dynamic_group_details, opts = {}) ⇒ Response
Creates a new dynamic group in your tenancy.
-
#create_group(create_group_details, opts = {}) ⇒ Response
Creates a new group in your tenancy.
-
#create_identity_provider(create_identity_provider_details, opts = {}) ⇒ Response
Creates a new identity provider in your tenancy.
-
#create_idp_group_mapping(create_idp_group_mapping_details, identity_provider_id, opts = {}) ⇒ Response
Creates a single mapping between an IdP group and an IAM Service Group.
-
#create_mfa_totp_device(user_id, opts = {}) ⇒ Response
Creates a new MFA TOTP device for the user.
-
#create_or_reset_ui_password(user_id, opts = {}) ⇒ Response
Creates a new Console one-time password for the specified user.
-
#create_policy(create_policy_details, opts = {}) ⇒ Response
Creates a new policy in the specified compartment (either the tenancy or another of your compartments).
-
#create_region_subscription(create_region_subscription_details, tenancy_id, opts = {}) ⇒ Response
Creates a subscription to a region for a tenancy.
-
#create_smtp_credential(create_smtp_credential_details, user_id, opts = {}) ⇒ Response
Creates a new SMTP credential for the specified user.
-
#create_swift_password(create_swift_password_details, user_id, opts = {}) ⇒ Response
**Deprecated.
-
#create_tag(tag_namespace_id, create_tag_details, opts = {}) ⇒ Response
Creates a new tag in the specified tag namespace.
-
#create_tag_default(create_tag_default_details, opts = {}) ⇒ Response
Creates a new tag default in the specified compartment for the specified tag definition.
-
#create_tag_namespace(create_tag_namespace_details, opts = {}) ⇒ Response
Creates a new tag namespace in the specified compartment.
-
#create_user(create_user_details, opts = {}) ⇒ Response
Creates a new user in your tenancy.
-
#delete_api_key(user_id, fingerprint, opts = {}) ⇒ Response
Deletes the specified API signing key for the specified user.
-
#delete_auth_token(user_id, auth_token_id, opts = {}) ⇒ Response
Deletes the specified auth token for the specified user.
-
#delete_compartment(compartment_id, opts = {}) ⇒ Response
Deletes the specified compartment.
-
#delete_customer_secret_key(user_id, customer_secret_key_id, opts = {}) ⇒ Response
Deletes the specified secret key for the specified user.
-
#delete_dynamic_group(dynamic_group_id, opts = {}) ⇒ Response
Deletes the specified dynamic group.
-
#delete_group(group_id, opts = {}) ⇒ Response
Deletes the specified group.
-
#delete_identity_provider(identity_provider_id, opts = {}) ⇒ Response
Deletes the specified identity provider.
-
#delete_idp_group_mapping(identity_provider_id, mapping_id, opts = {}) ⇒ Response
Deletes the specified group mapping.
-
#delete_mfa_totp_device(user_id, mfa_totp_device_id, opts = {}) ⇒ Response
Deletes the specified MFA TOTP device for the specified user.
-
#delete_policy(policy_id, opts = {}) ⇒ Response
Deletes the specified policy.
-
#delete_smtp_credential(user_id, smtp_credential_id, opts = {}) ⇒ Response
Deletes the specified SMTP credential for the specified user.
-
#delete_swift_password(user_id, swift_password_id, opts = {}) ⇒ Response
**Deprecated.
-
#delete_tag(tag_namespace_id, tag_name, opts = {}) ⇒ Response
Deletes the the specified tag definition.
-
#delete_tag_default(tag_default_id, opts = {}) ⇒ Response
Deletes the the specified tag default.
-
#delete_tag_namespace(tag_namespace_id, opts = {}) ⇒ Response
Delete the specified tag namespace.
-
#delete_user(user_id, opts = {}) ⇒ Response
Deletes the specified user.
-
#generate_totp_seed(user_id, mfa_totp_device_id, opts = {}) ⇒ Response
Generate seed for the MFA TOTP device.
-
#get_authentication_policy(compartment_id, opts = {}) ⇒ Response
Gets the authentication policy for the given tenancy.
-
#get_compartment(compartment_id, opts = {}) ⇒ Response
Gets the specified compartment’s information.
-
#get_dynamic_group(dynamic_group_id, opts = {}) ⇒ Response
Gets the specified dynamic group’s information.
-
#get_group(group_id, opts = {}) ⇒ Response
Gets the specified group’s information.
-
#get_identity_provider(identity_provider_id, opts = {}) ⇒ Response
Gets the specified identity provider’s information.
-
#get_idp_group_mapping(identity_provider_id, mapping_id, opts = {}) ⇒ Response
Gets the specified group mapping.
-
#get_mfa_totp_device(user_id, mfa_totp_device_id, opts = {}) ⇒ Response
Get the specified MFA TOTP device for the specified user.
-
#get_policy(policy_id, opts = {}) ⇒ Response
Gets the specified policy’s information.
-
#get_tag(tag_namespace_id, tag_name, opts = {}) ⇒ Response
Gets the specified tag’s information.
-
#get_tag_default(tag_default_id, opts = {}) ⇒ Response
Retrieves the specified tag default.
-
#get_tag_namespace(tag_namespace_id, opts = {}) ⇒ Response
Gets the specified tag namespace’s information.
-
#get_tenancy(tenancy_id, opts = {}) ⇒ Response
Get the specified tenancy’s information.
-
#get_user(user_id, opts = {}) ⇒ Response
Gets the specified user’s information.
-
#get_user_group_membership(user_group_membership_id, opts = {}) ⇒ Response
Gets the specified UserGroupMembership’s information.
-
#get_user_ui_password_information(user_id, opts = {}) ⇒ Response
Gets the specified user’s console password information.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets details on a specified work request.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ IdentityClient
constructor
Creates a new IdentityClient.
-
#list_api_keys(user_id, opts = {}) ⇒ Response
Lists the API signing keys for the specified user.
-
#list_auth_tokens(user_id, opts = {}) ⇒ Response
Lists the auth tokens for the specified user.
-
#list_availability_domains(compartment_id, opts = {}) ⇒ Response
Lists the availability domains in your tenancy.
-
#list_compartments(compartment_id, opts = {}) ⇒ Response
Lists the compartments in a specified compartment.
-
#list_cost_tracking_tags(compartment_id, opts = {}) ⇒ Response
Lists all the tags enabled for cost-tracking in the specified tenancy.
-
#list_customer_secret_keys(user_id, opts = {}) ⇒ Response
Lists the secret keys for the specified user.
-
#list_dynamic_groups(compartment_id, opts = {}) ⇒ Response
Lists the dynamic groups in your tenancy.
-
#list_fault_domains(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the Fault Domains in your tenancy.
-
#list_groups(compartment_id, opts = {}) ⇒ Response
Lists the groups in your tenancy.
-
#list_identity_provider_groups(identity_provider_id, opts = {}) ⇒ Response
Lists the identity provider groups.
-
#list_identity_providers(protocol, compartment_id, opts = {}) ⇒ Response
Lists all the identity providers in your tenancy.
-
#list_idp_group_mappings(identity_provider_id, opts = {}) ⇒ Response
Lists the group mappings for the specified identity provider.
-
#list_mfa_totp_devices(user_id, opts = {}) ⇒ Response
Lists the MFA TOTP devices for the specified user.
-
#list_policies(compartment_id, opts = {}) ⇒ Response
Lists the policies in the specified compartment (either the tenancy or another of your compartments).
-
#list_region_subscriptions(tenancy_id, opts = {}) ⇒ Response
Lists the region subscriptions for the specified tenancy.
-
#list_regions(opts = {}) ⇒ Response
Lists all the regions offered by Oracle Cloud Infrastructure.
-
#list_smtp_credentials(user_id, opts = {}) ⇒ Response
Lists the SMTP credentials for the specified user.
-
#list_swift_passwords(user_id, opts = {}) ⇒ Response
**Deprecated.
-
#list_tag_defaults(opts = {}) ⇒ Response
Lists the tag defaults for tag definitions in the specified compartment.
-
#list_tag_namespaces(compartment_id, opts = {}) ⇒ Response
Lists the tag namespaces in the specified compartment.
-
#list_tags(tag_namespace_id, opts = {}) ⇒ Response
Lists the tag definitions in the specified tag namespace.
-
#list_user_group_memberships(compartment_id, opts = {}) ⇒ Response
Lists the ‘UserGroupMembership` objects in your tenancy.
-
#list_users(compartment_id, opts = {}) ⇒ Response
Lists the users in your tenancy.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#move_compartment(compartment_id, move_compartment_details, opts = {}) ⇒ Response
Move the compartment tree to a different parent compartment.
-
#remove_user_from_group(user_group_membership_id, opts = {}) ⇒ Response
Removes a user from a group by deleting the corresponding ‘UserGroupMembership`.
-
#reset_idp_scim_client(identity_provider_id, opts = {}) ⇒ Response
Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
-
#update_auth_token(user_id, auth_token_id, update_auth_token_details, opts = {}) ⇒ Response
Updates the specified auth token’s description.
-
#update_authentication_policy(compartment_id, update_authentication_policy_details, opts = {}) ⇒ Response
Updates authentication policy for the specified tenancy.
-
#update_compartment(compartment_id, update_compartment_details, opts = {}) ⇒ Response
Updates the specified compartment’s description or name.
-
#update_customer_secret_key(user_id, customer_secret_key_id, update_customer_secret_key_details, opts = {}) ⇒ Response
Updates the specified secret key’s description.
-
#update_dynamic_group(dynamic_group_id, update_dynamic_group_details, opts = {}) ⇒ Response
Updates the specified dynamic group.
-
#update_group(group_id, update_group_details, opts = {}) ⇒ Response
Updates the specified group.
-
#update_identity_provider(identity_provider_id, update_identity_provider_details, opts = {}) ⇒ Response
Updates the specified identity provider.
-
#update_idp_group_mapping(identity_provider_id, mapping_id, update_idp_group_mapping_details, opts = {}) ⇒ Response
Updates the specified group mapping.
-
#update_policy(policy_id, update_policy_details, opts = {}) ⇒ Response
Updates the specified policy.
-
#update_smtp_credential(user_id, smtp_credential_id, update_smtp_credential_details, opts = {}) ⇒ Response
Updates the specified SMTP credential’s description.
-
#update_swift_password(user_id, swift_password_id, update_swift_password_details, opts = {}) ⇒ Response
**Deprecated.
-
#update_tag(tag_namespace_id, tag_name, update_tag_details, opts = {}) ⇒ Response
Updates the the specified tag definition.
-
#update_tag_default(tag_default_id, update_tag_default_details, opts = {}) ⇒ Response
Updates the specified tag default.
-
#update_tag_namespace(tag_namespace_id, update_tag_namespace_details, opts = {}) ⇒ Response
Updates the the specified tag namespace.
-
#update_user(user_id, update_user_details, opts = {}) ⇒ Response
Updates the description of the specified user.
-
#update_user_capabilities(user_id, update_user_capabilities_details, opts = {}) ⇒ Response
Updates the capabilities of the specified user.
-
#update_user_state(user_id, update_state_details, opts = {}) ⇒ Response
Updates the state of the specified user.
-
#upload_api_key(user_id, create_api_key_details, opts = {}) ⇒ Response
Uploads an API signing key for the specified user.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ IdentityClient
Creates a new IdentityClient. Notes:
If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the
region. A region may be specified in the config or via or the region parameter. If specified in both, then the
region parameter will be used.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/oci/identity/identity_client.rb', line 52 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config ||= OCI.config unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20160918' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "IdentityClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
12 13 14 |
# File 'lib/oci/identity/identity_client.rb', line 12 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
16 17 18 |
# File 'lib/oci/identity/identity_client.rb', line 16 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
26 27 28 |
# File 'lib/oci/identity/identity_client.rb', line 26 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is ‘nil`, which means that an operation will not perform any retries
22 23 24 |
# File 'lib/oci/identity/identity_client.rb', line 22 def retry_config @retry_config end |
Instance Method Details
#activate_mfa_totp_device(user_id, mfa_totp_device_id, mfa_totp_token, opts = {}) ⇒ Response
Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/oci/identity/identity_client.rb', line 130 def activate_mfa_totp_device(user_id, mfa_totp_device_id, mfa_totp_token, opts = {}) logger.debug 'Calling operation IdentityClient#activate_mfa_totp_device.' if logger raise "Missing the required parameter 'user_id' when calling activate_mfa_totp_device." if user_id.nil? raise "Missing the required parameter 'mfa_totp_device_id' when calling activate_mfa_totp_device." if mfa_totp_device_id.nil? raise "Missing the required parameter 'mfa_totp_token' when calling activate_mfa_totp_device." if mfa_totp_token.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'mfa_totp_device_id' must not be blank" if OCI::Internal::Util.blank_string?(mfa_totp_device_id) path = '/users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/activate'.sub('{userId}', user_id.to_s).sub('{mfaTotpDeviceId}', mfa_totp_device_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(mfa_totp_token) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#activate_mfa_totp_device') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::MfaTotpDeviceSummary' ) end # rubocop:enable Metrics/BlockLength end |
#add_user_to_group(add_user_to_group_details, opts = {}) ⇒ Response
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.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/oci/identity/identity_client.rb', line 197 def add_user_to_group(add_user_to_group_details, opts = {}) logger.debug 'Calling operation IdentityClient#add_user_to_group.' if logger raise "Missing the required parameter 'add_user_to_group_details' when calling add_user_to_group." if add_user_to_group_details.nil? path = '/userGroupMemberships/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(add_user_to_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#add_user_to_group') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::UserGroupMembership' ) end # rubocop:enable Metrics/BlockLength end |
#change_tag_namespace_compartment(tag_namespace_id, change_tag_namespace_compartment_detail, opts = {}) ⇒ Response
Moves the specified tag namespace to the specified compartment within the same tenancy.
To move the tag namespace, you must have the manage tag-namespaces permission on both compartments. For more information about IAM policies, see [Details for IAM](docs.cloud.oracle.com/Content/Identity/Reference/iampolicyreference.htm).
Moving a tag namespace moves all the tag key definitions contained in the tag namespace.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/oci/identity/identity_client.rb', line 263 def change_tag_namespace_compartment(tag_namespace_id, change_tag_namespace_compartment_detail, opts = {}) logger.debug 'Calling operation IdentityClient#change_tag_namespace_compartment.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling change_tag_namespace_compartment." if tag_namespace_id.nil? raise "Missing the required parameter 'change_tag_namespace_compartment_detail' when calling change_tag_namespace_compartment." if change_tag_namespace_compartment_detail.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) path = '/tagNamespaces/{tagNamespaceId}/actions/changeCompartment'.sub('{tagNamespaceId}', tag_namespace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_tag_namespace_compartment_detail) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#change_tag_namespace_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_auth_token(create_auth_token_details, user_id, opts = {}) ⇒ Response
Creates a new auth token for the specified user. For information about what auth tokens are for, see [Managing User Credentials](docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm).
You must specify a description for the auth token (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_auth_token.
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.
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/oci/identity/identity_client.rb', line 333 def create_auth_token(create_auth_token_details, user_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_auth_token.' if logger raise "Missing the required parameter 'create_auth_token_details' when calling create_auth_token." if create_auth_token_details.nil? raise "Missing the required parameter 'user_id' when calling create_auth_token." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/authTokens/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_auth_token_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_auth_token') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::AuthToken' ) end # rubocop:enable Metrics/BlockLength end |
#create_compartment(create_compartment_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a name for the compartment, which must be unique across all compartments in your tenancy. You can use this name or the OCID when writing policies that apply to the compartment. For more information about policies, see [How Policies Work](docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm).
You must also specify a description for the compartment (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_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.
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/oci/identity/identity_client.rb', line 412 def create_compartment(create_compartment_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_compartment.' if logger raise "Missing the required parameter 'create_compartment_details' when calling create_compartment." if create_compartment_details.nil? path = '/compartments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Compartment' ) end # rubocop:enable Metrics/BlockLength end |
#create_customer_secret_key(create_customer_secret_key_details, user_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm).
You must specify a description for the secret key (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_customer_secret_key.
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.
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/oci/identity/identity_client.rb', line 482 def create_customer_secret_key(create_customer_secret_key_details, user_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_customer_secret_key.' if logger raise "Missing the required parameter 'create_customer_secret_key_details' when calling create_customer_secret_key." if create_customer_secret_key_details.nil? raise "Missing the required parameter 'user_id' when calling create_customer_secret_key." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/customerSecretKeys/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_customer_secret_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_customer_secret_key') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::CustomerSecretKey' ) end # rubocop:enable Metrics/BlockLength end |
#create_dynamic_group(create_dynamic_group_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a name for the dynamic group, which must be unique across all dynamic groups in your tenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy. You can use this name or the OCID when writing policies that apply to the dynamic group. For more information about policies, see [How Policies Work](docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm).
You must also specify a description for the dynamic group (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_dynamic_group.
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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'lib/oci/identity/identity_client.rb', line 560 def create_dynamic_group(create_dynamic_group_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_dynamic_group.' if logger raise "Missing the required parameter 'create_dynamic_group_details' when calling create_dynamic_group." if create_dynamic_group_details.nil? path = '/dynamicGroups/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_dynamic_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_dynamic_group') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::DynamicGroup' ) end # rubocop:enable Metrics/BlockLength end |
#create_group(create_group_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a name for the group, which must be unique across all groups in your tenancy and cannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more information about policies, see [How Policies Work](docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm).
You must also specify a description for the group (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_group.
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 add_user_to_group and create_policy.
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 |
# File 'lib/oci/identity/identity_client.rb', line 639 def create_group(create_group_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_group.' if logger raise "Missing the required parameter 'create_group_details' when calling create_group." if create_group_details.nil? path = '/groups/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_group') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Group' ) end # rubocop:enable Metrics/BlockLength end |
#create_identity_provider(create_identity_provider_details, opts = {}) ⇒ Response
Creates a new identity provider in your tenancy. For more information, see [Identity Providers and Federation](docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm).
You must specify your tenancy’s OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see [Resource Identifiers](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a name for the ‘IdentityProvider`, which must be unique across all `IdentityProvider` objects in your tenancy and cannot be changed.
You must also specify a description for the ‘IdentityProvider` (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_identity_provider.
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.
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 |
# File 'lib/oci/identity/identity_client.rb', line 715 def create_identity_provider(create_identity_provider_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_identity_provider.' if logger raise "Missing the required parameter 'create_identity_provider_details' when calling create_identity_provider." if create_identity_provider_details.nil? path = '/identityProviders/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_identity_provider_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_identity_provider') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::IdentityProvider' ) end # rubocop:enable Metrics/BlockLength end |
#create_idp_group_mapping(create_idp_group_mapping_details, identity_provider_id, opts = {}) ⇒ Response
Creates a single mapping between an IdP group and an IAM Service Group.
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/oci/identity/identity_client.rb', line 776 def create_idp_group_mapping(create_idp_group_mapping_details, identity_provider_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_idp_group_mapping.' if logger raise "Missing the required parameter 'create_idp_group_mapping_details' when calling create_idp_group_mapping." if create_idp_group_mapping_details.nil? raise "Missing the required parameter 'identity_provider_id' when calling create_idp_group_mapping." if identity_provider_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}/groupMappings/'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_idp_group_mapping_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_idp_group_mapping') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::IdpGroupMapping' ) end # rubocop:enable Metrics/BlockLength end |
#create_mfa_totp_device(user_id, opts = {}) ⇒ Response
Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 |
# File 'lib/oci/identity/identity_client.rb', line 837 def create_mfa_totp_device(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_mfa_totp_device.' if logger raise "Missing the required parameter 'user_id' when calling create_mfa_totp_device." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/mfaTotpDevices'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_mfa_totp_device') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::MfaTotpDevice' ) end # rubocop:enable Metrics/BlockLength end |
#create_or_reset_ui_password(user_id, opts = {}) ⇒ Response
Creates a new Console one-time password for the specified user. For more information about user credentials, see [User Credentials](docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm).
Use this operation after creating a new user, or if a user forgets their password. The new one-time password is returned to you in the response, and you must securely deliver it to the user. They’ll be prompted to change this password the next time they sign in to the Console. If they don’t change it within 7 days, the password will expire and you’ll need to create a new one-time password for the user.
Note: The user’s Console login is the unique name you specified when you created the user (see create_user).
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 |
# File 'lib/oci/identity/identity_client.rb', line 907 def create_or_reset_ui_password(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_or_reset_ui_password.' if logger raise "Missing the required parameter 'user_id' when calling create_or_reset_ui_password." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/uiPassword'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_or_reset_ui_password') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::UIPassword' ) end # rubocop:enable Metrics/BlockLength end |
#create_policy(create_policy_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
You must specify a name for the policy, which must be unique across all policies in your tenancy and cannot be changed.
You must also specify a description for the policy (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_policy.
You must specify one or more policy statements in the statements array. For information about writing policies, see [How Policies Work](docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm) and [Common Policies](docs.cloud.oracle.com/Content/Identity/Concepts/commonpolicies.htm).
After you send your request, the new object’s ‘lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
New policies take effect typically within 10 seconds.
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 |
# File 'lib/oci/identity/identity_client.rb', line 983 def create_policy(create_policy_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_policy.' if logger raise "Missing the required parameter 'create_policy_details' when calling create_policy." if create_policy_details.nil? path = '/policies/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_policy') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Policy' ) end # rubocop:enable Metrics/BlockLength end |
#create_region_subscription(create_region_subscription_details, tenancy_id, opts = {}) ⇒ Response
Creates a subscription to a region for a tenancy.
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'lib/oci/identity/identity_client.rb', line 1043 def create_region_subscription(create_region_subscription_details, tenancy_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_region_subscription.' if logger raise "Missing the required parameter 'create_region_subscription_details' when calling create_region_subscription." if create_region_subscription_details.nil? raise "Missing the required parameter 'tenancy_id' when calling create_region_subscription." if tenancy_id.nil? raise "Parameter value for 'tenancy_id' must not be blank" if OCI::Internal::Util.blank_string?(tenancy_id) path = '/tenancies/{tenancyId}/regionSubscriptions'.sub('{tenancyId}', tenancy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_region_subscription_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_region_subscription') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::RegionSubscription' ) end # rubocop:enable Metrics/BlockLength end |
#create_smtp_credential(create_smtp_credential_details, user_id, opts = {}) ⇒ Response
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 update_smtp_credential.
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 |
# File 'lib/oci/identity/identity_client.rb', line 1108 def create_smtp_credential(create_smtp_credential_details, user_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_smtp_credential.' if logger raise "Missing the required parameter 'create_smtp_credential_details' when calling create_smtp_credential." if create_smtp_credential_details.nil? raise "Missing the required parameter 'user_id' when calling create_smtp_credential." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/smtpCredentials/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_smtp_credential_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_smtp_credential') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::SmtpCredential' ) end # rubocop:enable Metrics/BlockLength end |
#create_swift_password(create_swift_password_details, user_id, opts = {}) ⇒ Response
**Deprecated. Use create_auth_token instead.**
Creates a new Swift password for the specified user. For information about what Swift passwords are for, see [Managing User Credentials](docs.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm).
You must specify a description for the Swift password (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_swift_password.
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.
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 |
# File 'lib/oci/identity/identity_client.rb', line 1181 def create_swift_password(create_swift_password_details, user_id, opts = {}) logger.debug 'Calling operation IdentityClient#create_swift_password.' if logger raise "Missing the required parameter 'create_swift_password_details' when calling create_swift_password." if create_swift_password_details.nil? raise "Missing the required parameter 'user_id' when calling create_swift_password." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/swiftPasswords/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_swift_password_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_swift_password') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::SwiftPassword' ) end # rubocop:enable Metrics/BlockLength end |
#create_tag(tag_namespace_id, create_tag_details, opts = {}) ⇒ Response
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 update_tag.
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 |
# File 'lib/oci/identity/identity_client.rb', line 1255 def create_tag(tag_namespace_id, create_tag_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_tag.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling create_tag." if tag_namespace_id.nil? raise "Missing the required parameter 'create_tag_details' when calling create_tag." if create_tag_details.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) path = '/tagNamespaces/{tagNamespaceId}/tags'.sub('{tagNamespaceId}', tag_namespace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_tag_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_tag') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Tag' ) end # rubocop:enable Metrics/BlockLength end |
#create_tag_default(create_tag_default_details, opts = {}) ⇒ Response
Creates a new tag default in the specified compartment for the specified tag definition.
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 |
# File 'lib/oci/identity/identity_client.rb', line 1319 def create_tag_default(create_tag_default_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_tag_default.' if logger raise "Missing the required parameter 'create_tag_default_details' when calling create_tag_default." if create_tag_default_details.nil? path = '/tagDefaults' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_tag_default_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_tag_default') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::TagDefault' ) end # rubocop:enable Metrics/BlockLength end |
#create_tag_namespace(create_tag_namespace_details, opts = {}) ⇒ Response
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 update_tag_namespace.
Tag namespaces cannot be deleted, but they can be retired. See [Retiring Key Definitions and Namespace Definitions](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#Retiring) for more information.
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 |
# File 'lib/oci/identity/identity_client.rb', line 1395 def create_tag_namespace(create_tag_namespace_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_tag_namespace.' if logger raise "Missing the required parameter 'create_tag_namespace_details' when calling create_tag_namespace." if create_tag_namespace_details.nil? path = '/tagNamespaces' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_tag_namespace_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_tag_namespace') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::TagNamespace' ) end # rubocop:enable Metrics/BlockLength end |
#create_user(create_user_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.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](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a name for the user, which must be unique across all users in your tenancy and cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods, underscores, +, and @. If you specify a name that’s already in use, you’ll get a 409 error. This name will be the user’s login to the Console. You might want to pick a name that your company’s own identity system (e.g., Active Directory, LDAP, etc.) already uses. If you delete a user and then create a new user with the same name, they’ll be considered different users because they have different OCIDs.
You must also specify a description for the user (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_user. 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 add_user_to_group). If the user needs to access the Console, you need to provide the user a password (see create_or_reset_ui_password). 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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm) and also upload_api_key).
Important: Make sure to inform the new user which compartment(s) they have access to.
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 |
# File 'lib/oci/identity/identity_client.rb', line 1488 def create_user(create_user_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_user.' if logger raise "Missing the required parameter 'create_user_details' when calling create_user." if create_user_details.nil? path = '/users/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_user_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_user') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::User' ) end # rubocop:enable Metrics/BlockLength end |
#delete_api_key(user_id, fingerprint, opts = {}) ⇒ Response
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.
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 |
# File 'lib/oci/identity/identity_client.rb', line 1551 def delete_api_key(user_id, fingerprint, opts = {}) logger.debug 'Calling operation IdentityClient#delete_api_key.' if logger raise "Missing the required parameter 'user_id' when calling delete_api_key." if user_id.nil? raise "Missing the required parameter 'fingerprint' when calling delete_api_key." if fingerprint.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'fingerprint' must not be blank" if OCI::Internal::Util.blank_string?(fingerprint) path = '/users/{userId}/apiKeys/{fingerprint}'.sub('{userId}', user_id.to_s).sub('{fingerprint}', fingerprint.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_api_key') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_auth_token(user_id, auth_token_id, opts = {}) ⇒ Response
Deletes the specified auth token for the specified user.
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 |
# File 'lib/oci/identity/identity_client.rb', line 1610 def delete_auth_token(user_id, auth_token_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_auth_token.' if logger raise "Missing the required parameter 'user_id' when calling delete_auth_token." if user_id.nil? raise "Missing the required parameter 'auth_token_id' when calling delete_auth_token." if auth_token_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(auth_token_id) path = '/users/{userId}/authTokens/{authTokenId}'.sub('{userId}', user_id.to_s).sub('{authTokenId}', auth_token_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_auth_token') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_compartment(compartment_id, opts = {}) ⇒ Response
Deletes the specified compartment. The compartment must be empty.
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 |
# File 'lib/oci/identity/identity_client.rb', line 1668 def delete_compartment(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_compartment.' if logger raise "Missing the required parameter 'compartment_id' when calling delete_compartment." if compartment_id.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/compartments/{compartmentId}'.sub('{compartmentId}', compartment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_compartment') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_customer_secret_key(user_id, customer_secret_key_id, opts = {}) ⇒ Response
Deletes the specified secret key for the specified user.
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 |
# File 'lib/oci/identity/identity_client.rb', line 1725 def delete_customer_secret_key(user_id, customer_secret_key_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_customer_secret_key.' if logger raise "Missing the required parameter 'user_id' when calling delete_customer_secret_key." if user_id.nil? raise "Missing the required parameter 'customer_secret_key_id' when calling delete_customer_secret_key." if customer_secret_key_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(customer_secret_key_id) path = '/users/{userId}/customerSecretKeys/{customerSecretKeyId}'.sub('{userId}', user_id.to_s).sub('{customerSecretKeyId}', customer_secret_key_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_customer_secret_key') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_dynamic_group(dynamic_group_id, opts = {}) ⇒ Response
Deletes the specified dynamic group.
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 |
# File 'lib/oci/identity/identity_client.rb', line 1783 def delete_dynamic_group(dynamic_group_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_dynamic_group.' if logger raise "Missing the required parameter 'dynamic_group_id' when calling delete_dynamic_group." if dynamic_group_id.nil? raise "Parameter value for 'dynamic_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_group_id) path = '/dynamicGroups/{dynamicGroupId}'.sub('{dynamicGroupId}', dynamic_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_dynamic_group') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_group(group_id, opts = {}) ⇒ Response
Deletes the specified group. The group must be empty.
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 |
# File 'lib/oci/identity/identity_client.rb', line 1839 def delete_group(group_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_group.' if logger raise "Missing the required parameter 'group_id' when calling delete_group." if group_id.nil? raise "Parameter value for 'group_id' must not be blank" if OCI::Internal::Util.blank_string?(group_id) path = '/groups/{groupId}'.sub('{groupId}', group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_group') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_identity_provider(identity_provider_id, opts = {}) ⇒ Response
Deletes the specified identity provider. The identity provider must not have any group mappings (see IdpGroupMapping).
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 |
# File 'lib/oci/identity/identity_client.rb', line 1896 def delete_identity_provider(identity_provider_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_identity_provider.' if logger raise "Missing the required parameter 'identity_provider_id' when calling delete_identity_provider." if identity_provider_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_identity_provider') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_idp_group_mapping(identity_provider_id, mapping_id, opts = {}) ⇒ Response
Deletes the specified group mapping.
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 |
# File 'lib/oci/identity/identity_client.rb', line 1952 def delete_idp_group_mapping(identity_provider_id, mapping_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_idp_group_mapping.' if logger raise "Missing the required parameter 'identity_provider_id' when calling delete_idp_group_mapping." if identity_provider_id.nil? raise "Missing the required parameter 'mapping_id' when calling delete_idp_group_mapping." if mapping_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) raise "Parameter value for 'mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(mapping_id) path = '/identityProviders/{identityProviderId}/groupMappings/{mappingId}'.sub('{identityProviderId}', identity_provider_id.to_s).sub('{mappingId}', mapping_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_idp_group_mapping') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_mfa_totp_device(user_id, mfa_totp_device_id, opts = {}) ⇒ Response
Deletes the specified MFA TOTP device for the specified user.
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 |
# File 'lib/oci/identity/identity_client.rb', line 2011 def delete_mfa_totp_device(user_id, mfa_totp_device_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_mfa_totp_device.' if logger raise "Missing the required parameter 'user_id' when calling delete_mfa_totp_device." if user_id.nil? raise "Missing the required parameter 'mfa_totp_device_id' when calling delete_mfa_totp_device." if mfa_totp_device_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'mfa_totp_device_id' must not be blank" if OCI::Internal::Util.blank_string?(mfa_totp_device_id) path = '/users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}'.sub('{userId}', user_id.to_s).sub('{mfaTotpDeviceId}', mfa_totp_device_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_mfa_totp_device') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_policy(policy_id, opts = {}) ⇒ Response
Deletes the specified policy. The deletion takes effect typically within 10 seconds.
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 |
# File 'lib/oci/identity/identity_client.rb', line 2068 def delete_policy(policy_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_policy.' if logger raise "Missing the required parameter 'policy_id' when calling delete_policy." if policy_id.nil? raise "Parameter value for 'policy_id' must not be blank" if OCI::Internal::Util.blank_string?(policy_id) path = '/policies/{policyId}'.sub('{policyId}', policy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_policy') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_smtp_credential(user_id, smtp_credential_id, opts = {}) ⇒ Response
Deletes the specified SMTP credential for the specified user.
2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 |
# File 'lib/oci/identity/identity_client.rb', line 2125 def delete_smtp_credential(user_id, smtp_credential_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_smtp_credential.' if logger raise "Missing the required parameter 'user_id' when calling delete_smtp_credential." if user_id.nil? raise "Missing the required parameter 'smtp_credential_id' when calling delete_smtp_credential." if smtp_credential_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(smtp_credential_id) path = '/users/{userId}/smtpCredentials/{smtpCredentialId}'.sub('{userId}', user_id.to_s).sub('{smtpCredentialId}', smtp_credential_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_smtp_credential') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_swift_password(user_id, swift_password_id, opts = {}) ⇒ Response
**Deprecated. Use delete_auth_token instead.**
Deletes the specified Swift password for the specified user.
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 |
# File 'lib/oci/identity/identity_client.rb', line 2186 def delete_swift_password(user_id, swift_password_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_swift_password.' if logger raise "Missing the required parameter 'user_id' when calling delete_swift_password." if user_id.nil? raise "Missing the required parameter 'swift_password_id' when calling delete_swift_password." if swift_password_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'swift_password_id' must not be blank" if OCI::Internal::Util.blank_string?(swift_password_id) path = '/users/{userId}/swiftPasswords/{swiftPasswordId}'.sub('{userId}', user_id.to_s).sub('{swiftPasswordId}', swift_password_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_swift_password') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_tag(tag_namespace_id, tag_name, opts = {}) ⇒ Response
Deletes the the specified tag definition.
2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 |
# File 'lib/oci/identity/identity_client.rb', line 2247 def delete_tag(tag_namespace_id, tag_name, opts = {}) logger.debug 'Calling operation IdentityClient#delete_tag.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling delete_tag." if tag_namespace_id.nil? raise "Missing the required parameter 'tag_name' when calling delete_tag." if tag_name.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) raise "Parameter value for 'tag_name' must not be blank" if OCI::Internal::Util.blank_string?(tag_name) path = '/tagNamespaces/{tagNamespaceId}/tags/{tagName}'.sub('{tagNamespaceId}', tag_namespace_id.to_s).sub('{tagName}', tag_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_tag') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_tag_default(tag_default_id, opts = {}) ⇒ Response
Deletes the the specified tag default.
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 |
# File 'lib/oci/identity/identity_client.rb', line 2308 def delete_tag_default(tag_default_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_tag_default.' if logger raise "Missing the required parameter 'tag_default_id' when calling delete_tag_default." if tag_default_id.nil? raise "Parameter value for 'tag_default_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_default_id) path = '/tagDefaults/{tagDefaultId}'.sub('{tagDefaultId}', tag_default_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_tag_default') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_tag_namespace(tag_namespace_id, opts = {}) ⇒ Response
Delete the specified tag namespace. Only an empty tagnamespace can be deleted. If the tag namespace you are trying to delete is not empty, please remove tag definitions from it first.
2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 |
# File 'lib/oci/identity/identity_client.rb', line 2370 def delete_tag_namespace(tag_namespace_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_tag_namespace.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling delete_tag_namespace." if tag_namespace_id.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) path = '/tagNamespaces/{tagNamespaceId}'.sub('{tagNamespaceId}', tag_namespace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_tag_namespace') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_user(user_id, opts = {}) ⇒ Response
Deletes the specified user. The user must not be in any groups.
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 |
# File 'lib/oci/identity/identity_client.rb', line 2426 def delete_user(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_user.' if logger raise "Missing the required parameter 'user_id' when calling delete_user." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#delete_user') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#generate_totp_seed(user_id, mfa_totp_device_id, opts = {}) ⇒ Response
Generate seed for the MFA TOTP device.
2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 |
# File 'lib/oci/identity/identity_client.rb', line 2483 def generate_totp_seed(user_id, mfa_totp_device_id, opts = {}) logger.debug 'Calling operation IdentityClient#generate_totp_seed.' if logger raise "Missing the required parameter 'user_id' when calling generate_totp_seed." if user_id.nil? raise "Missing the required parameter 'mfa_totp_device_id' when calling generate_totp_seed." if mfa_totp_device_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'mfa_totp_device_id' must not be blank" if OCI::Internal::Util.blank_string?(mfa_totp_device_id) path = '/users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/generateSeed'.sub('{userId}', user_id.to_s).sub('{mfaTotpDeviceId}', mfa_totp_device_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#generate_totp_seed') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::MfaTotpDevice' ) end # rubocop:enable Metrics/BlockLength end |
#get_authentication_policy(compartment_id, opts = {}) ⇒ Response
Gets the authentication policy for the given tenancy. You must specify your tenantu2019s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment).
2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 |
# File 'lib/oci/identity/identity_client.rb', line 2540 def get_authentication_policy(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_authentication_policy.' if logger raise "Missing the required parameter 'compartment_id' when calling get_authentication_policy." if compartment_id.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/authenticationPolicies/{compartmentId}'.sub('{compartmentId}', compartment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_authentication_policy') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::AuthenticationPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#get_compartment(compartment_id, opts = {}) ⇒ Response
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 list_instances operation in the Cloud Compute Service or the list_volumes operation in Cloud Block Storage.
2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 |
# File 'lib/oci/identity/identity_client.rb', line 2601 def get_compartment(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_compartment.' if logger raise "Missing the required parameter 'compartment_id' when calling get_compartment." if compartment_id.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/compartments/{compartmentId}'.sub('{compartmentId}', compartment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_compartment') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Compartment' ) end # rubocop:enable Metrics/BlockLength end |
#get_dynamic_group(dynamic_group_id, opts = {}) ⇒ Response
Gets the specified dynamic group’s information.
2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 |
# File 'lib/oci/identity/identity_client.rb', line 2655 def get_dynamic_group(dynamic_group_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_dynamic_group.' if logger raise "Missing the required parameter 'dynamic_group_id' when calling get_dynamic_group." if dynamic_group_id.nil? raise "Parameter value for 'dynamic_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_group_id) path = '/dynamicGroups/{dynamicGroupId}'.sub('{dynamicGroupId}', dynamic_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_dynamic_group') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::DynamicGroup' ) end # rubocop:enable Metrics/BlockLength end |
#get_group(group_id, opts = {}) ⇒ Response
Gets the specified group’s information.
This operation does not return a list of all the users in the group. To do that, use list_user_group_memberships and provide the group’s OCID as a query parameter in the request.
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 |
# File 'lib/oci/identity/identity_client.rb', line 2713 def get_group(group_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_group.' if logger raise "Missing the required parameter 'group_id' when calling get_group." if group_id.nil? raise "Parameter value for 'group_id' must not be blank" if OCI::Internal::Util.blank_string?(group_id) path = '/groups/{groupId}'.sub('{groupId}', group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_group') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Group' ) end # rubocop:enable Metrics/BlockLength end |
#get_identity_provider(identity_provider_id, opts = {}) ⇒ Response
Gets the specified identity provider’s information.
2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 |
# File 'lib/oci/identity/identity_client.rb', line 2766 def get_identity_provider(identity_provider_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_identity_provider.' if logger raise "Missing the required parameter 'identity_provider_id' when calling get_identity_provider." if identity_provider_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_identity_provider') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::IdentityProvider' ) end # rubocop:enable Metrics/BlockLength end |
#get_idp_group_mapping(identity_provider_id, mapping_id, opts = {}) ⇒ Response
Gets the specified group mapping.
2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 |
# File 'lib/oci/identity/identity_client.rb', line 2820 def get_idp_group_mapping(identity_provider_id, mapping_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_idp_group_mapping.' if logger raise "Missing the required parameter 'identity_provider_id' when calling get_idp_group_mapping." if identity_provider_id.nil? raise "Missing the required parameter 'mapping_id' when calling get_idp_group_mapping." if mapping_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) raise "Parameter value for 'mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(mapping_id) path = '/identityProviders/{identityProviderId}/groupMappings/{mappingId}'.sub('{identityProviderId}', identity_provider_id.to_s).sub('{mappingId}', mapping_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_idp_group_mapping') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::IdpGroupMapping' ) end # rubocop:enable Metrics/BlockLength end |
#get_mfa_totp_device(user_id, mfa_totp_device_id, opts = {}) ⇒ Response
Get the specified MFA TOTP device for the specified user.
2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 |
# File 'lib/oci/identity/identity_client.rb', line 2877 def get_mfa_totp_device(user_id, mfa_totp_device_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_mfa_totp_device.' if logger raise "Missing the required parameter 'user_id' when calling get_mfa_totp_device." if user_id.nil? raise "Missing the required parameter 'mfa_totp_device_id' when calling get_mfa_totp_device." if mfa_totp_device_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'mfa_totp_device_id' must not be blank" if OCI::Internal::Util.blank_string?(mfa_totp_device_id) path = '/users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}'.sub('{userId}', user_id.to_s).sub('{mfaTotpDeviceId}', mfa_totp_device_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_mfa_totp_device') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::MfaTotpDeviceSummary' ) end # rubocop:enable Metrics/BlockLength end |
#get_policy(policy_id, opts = {}) ⇒ Response
Gets the specified policy’s information.
2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 |
# File 'lib/oci/identity/identity_client.rb', line 2932 def get_policy(policy_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_policy.' if logger raise "Missing the required parameter 'policy_id' when calling get_policy." if policy_id.nil? raise "Parameter value for 'policy_id' must not be blank" if OCI::Internal::Util.blank_string?(policy_id) path = '/policies/{policyId}'.sub('{policyId}', policy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_policy') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Policy' ) end # rubocop:enable Metrics/BlockLength end |
#get_tag(tag_namespace_id, tag_name, opts = {}) ⇒ Response
Gets the specified tag’s information.
2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 |
# File 'lib/oci/identity/identity_client.rb', line 2988 def get_tag(tag_namespace_id, tag_name, opts = {}) logger.debug 'Calling operation IdentityClient#get_tag.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling get_tag." if tag_namespace_id.nil? raise "Missing the required parameter 'tag_name' when calling get_tag." if tag_name.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) raise "Parameter value for 'tag_name' must not be blank" if OCI::Internal::Util.blank_string?(tag_name) path = '/tagNamespaces/{tagNamespaceId}/tags/{tagName}'.sub('{tagNamespaceId}', tag_namespace_id.to_s).sub('{tagName}', tag_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_tag') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Tag' ) end # rubocop:enable Metrics/BlockLength end |
#get_tag_default(tag_default_id, opts = {}) ⇒ Response
Retrieves the specified tag default.
3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 |
# File 'lib/oci/identity/identity_client.rb', line 3044 def get_tag_default(tag_default_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_tag_default.' if logger raise "Missing the required parameter 'tag_default_id' when calling get_tag_default." if tag_default_id.nil? raise "Parameter value for 'tag_default_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_default_id) path = '/tagDefaults/{tagDefaultId}'.sub('{tagDefaultId}', tag_default_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_tag_default') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::TagDefault' ) end # rubocop:enable Metrics/BlockLength end |
#get_tag_namespace(tag_namespace_id, opts = {}) ⇒ Response
Gets the specified tag namespace’s information.
3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 |
# File 'lib/oci/identity/identity_client.rb', line 3099 def get_tag_namespace(tag_namespace_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_tag_namespace.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling get_tag_namespace." if tag_namespace_id.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) path = '/tagNamespaces/{tagNamespaceId}'.sub('{tagNamespaceId}', tag_namespace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_tag_namespace') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::TagNamespace' ) end # rubocop:enable Metrics/BlockLength end |
#get_tenancy(tenancy_id, opts = {}) ⇒ Response
Get the specified tenancy’s information.
3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 |
# File 'lib/oci/identity/identity_client.rb', line 3152 def get_tenancy(tenancy_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_tenancy.' if logger raise "Missing the required parameter 'tenancy_id' when calling get_tenancy." if tenancy_id.nil? raise "Parameter value for 'tenancy_id' must not be blank" if OCI::Internal::Util.blank_string?(tenancy_id) path = '/tenancies/{tenancyId}'.sub('{tenancyId}', tenancy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_tenancy') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Tenancy' ) end # rubocop:enable Metrics/BlockLength end |
#get_user(user_id, opts = {}) ⇒ Response
Gets the specified user’s information.
3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 |
# File 'lib/oci/identity/identity_client.rb', line 3205 def get_user(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_user.' if logger raise "Missing the required parameter 'user_id' when calling get_user." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_user') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::User' ) end # rubocop:enable Metrics/BlockLength end |
#get_user_group_membership(user_group_membership_id, opts = {}) ⇒ Response
Gets the specified UserGroupMembership’s information.
3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 |
# File 'lib/oci/identity/identity_client.rb', line 3258 def get_user_group_membership(user_group_membership_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_user_group_membership.' if logger raise "Missing the required parameter 'user_group_membership_id' when calling get_user_group_membership." if user_group_membership_id.nil? raise "Parameter value for 'user_group_membership_id' must not be blank" if OCI::Internal::Util.blank_string?(user_group_membership_id) path = '/userGroupMemberships/{userGroupMembershipId}'.sub('{userGroupMembershipId}', user_group_membership_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_user_group_membership') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::UserGroupMembership' ) end # rubocop:enable Metrics/BlockLength end |
#get_user_ui_password_information(user_id, opts = {}) ⇒ Response
Gets the specified user’s console password information. The returned object contains the user’s OCID, but not the password itself. The actual password is returned only when created or reset.
3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 |
# File 'lib/oci/identity/identity_client.rb', line 3313 def get_user_ui_password_information(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_user_ui_password_information.' if logger raise "Missing the required parameter 'user_id' when calling get_user_ui_password_information." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/uiPassword'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_user_ui_password_information') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::UIPasswordInformation' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
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.
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 |
# File 'lib/oci/identity/identity_client.rb', line 3368 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#get_work_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_api_keys(user_id, opts = {}) ⇒ Response
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.
3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 |
# File 'lib/oci/identity/identity_client.rb', line 3425 def list_api_keys(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_api_keys.' if logger raise "Missing the required parameter 'user_id' when calling list_api_keys." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/apiKeys/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_api_keys') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::ApiKey>' ) end # rubocop:enable Metrics/BlockLength end |
#list_auth_tokens(user_id, opts = {}) ⇒ Response
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.
3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 |
# File 'lib/oci/identity/identity_client.rb', line 3480 def list_auth_tokens(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_auth_tokens.' if logger raise "Missing the required parameter 'user_id' when calling list_auth_tokens." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/authTokens/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_auth_tokens') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::AuthToken>' ) end # rubocop:enable Metrics/BlockLength end |
#list_availability_domains(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five). Note that the order of the results returned can change if availability domains are added or removed; therefore, do not create a dependency on the list order.
3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 |
# File 'lib/oci/identity/identity_client.rb', line 3539 def list_availability_domains(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_availability_domains.' if logger raise "Missing the required parameter 'compartment_id' when calling list_availability_domains." if compartment_id.nil? path = '/availabilityDomains/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_availability_domains') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::AvailabilityDomain>' ) end # rubocop:enable Metrics/BlockLength end |
#list_compartments(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 |
# File 'lib/oci/identity/identity_client.rb', line 3629 def list_compartments(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_compartments.' if logger raise "Missing the required parameter 'compartment_id' when calling list_compartments." if compartment_id.nil? if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level]) raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.' end path = '/compartments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:accessLevel] = opts[:access_level] if opts[:access_level] query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_compartments') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::Compartment>' ) end # rubocop:enable Metrics/BlockLength end |
#list_cost_tracking_tags(compartment_id, opts = {}) ⇒ Response
Lists all the tags enabled for cost-tracking in the specified tenancy. For information about cost-tracking tags, see [Using Cost-tracking Tags](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#costs).
3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 |
# File 'lib/oci/identity/identity_client.rb', line 3695 def (compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_cost_tracking_tags.' if logger raise "Missing the required parameter 'compartment_id' when calling list_cost_tracking_tags." if compartment_id.nil? path = '/tagNamespaces/actions/listCostTrackingTags' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_cost_tracking_tags') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::Tag>' ) end # rubocop:enable Metrics/BlockLength end |
#list_customer_secret_keys(user_id, opts = {}) ⇒ Response
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.
3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 |
# File 'lib/oci/identity/identity_client.rb', line 3751 def list_customer_secret_keys(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_customer_secret_keys.' if logger raise "Missing the required parameter 'user_id' when calling list_customer_secret_keys." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/customerSecretKeys/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_customer_secret_keys') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::CustomerSecretKeySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_dynamic_groups(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 |
# File 'lib/oci/identity/identity_client.rb', line 3811 def list_dynamic_groups(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_dynamic_groups.' if logger raise "Missing the required parameter 'compartment_id' when calling list_dynamic_groups." if compartment_id.nil? path = '/dynamicGroups/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_dynamic_groups') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::DynamicGroup>' ) end # rubocop:enable Metrics/BlockLength end |
#list_fault_domains(compartment_id, availability_domain, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 |
# File 'lib/oci/identity/identity_client.rb', line 3871 def list_fault_domains(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation IdentityClient#list_fault_domains.' if logger raise "Missing the required parameter 'compartment_id' when calling list_fault_domains." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_fault_domains." if availability_domain.nil? path = '/faultDomains/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_fault_domains') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::FaultDomain>' ) end # rubocop:enable Metrics/BlockLength end |
#list_groups(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 |
# File 'lib/oci/identity/identity_client.rb', line 3933 def list_groups(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_groups.' if logger raise "Missing the required parameter 'compartment_id' when calling list_groups." if compartment_id.nil? path = '/groups/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_groups') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::Group>' ) end # rubocop:enable Metrics/BlockLength end |
#list_identity_provider_groups(identity_provider_id, opts = {}) ⇒ Response
Lists the identity provider groups.
3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 |
# File 'lib/oci/identity/identity_client.rb', line 3990 def list_identity_provider_groups(identity_provider_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_identity_provider_groups.' if logger raise "Missing the required parameter 'identity_provider_id' when calling list_identity_provider_groups." if identity_provider_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}/groups/'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_identity_provider_groups') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::IdentityProviderGroupSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_identity_providers(protocol, compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 |
# File 'lib/oci/identity/identity_client.rb', line 4054 def list_identity_providers(protocol, compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_identity_providers.' if logger raise "Missing the required parameter 'protocol' when calling list_identity_providers." if protocol.nil? unless %w[SAML2].include?(protocol) raise "Invalid value for 'protocol', must be one of SAML2." end raise "Missing the required parameter 'compartment_id' when calling list_identity_providers." if compartment_id.nil? path = '/identityProviders/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:protocol] = protocol query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_identity_providers') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::IdentityProvider>' ) end # rubocop:enable Metrics/BlockLength end |
#list_idp_group_mappings(identity_provider_id, opts = {}) ⇒ Response
Lists the group mappings for the specified identity provider.
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 |
# File 'lib/oci/identity/identity_client.rb', line 4117 def list_idp_group_mappings(identity_provider_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_idp_group_mappings.' if logger raise "Missing the required parameter 'identity_provider_id' when calling list_idp_group_mappings." if identity_provider_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}/groupMappings/'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_idp_group_mappings') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::IdpGroupMapping>' ) end # rubocop:enable Metrics/BlockLength end |
#list_mfa_totp_devices(user_id, opts = {}) ⇒ Response
Lists the MFA TOTP devices for the specified user. The returned object contains the device’s OCID, but not the seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.
4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 |
# File 'lib/oci/identity/identity_client.rb', line 4190 def list_mfa_totp_devices(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_mfa_totp_devices.' if logger raise "Missing the required parameter 'user_id' when calling list_mfa_totp_devices." if user_id.nil? if opts[:sort_by] && !%w[TIMECREATED NAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, NAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/mfaTotpDevices'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_mfa_totp_devices') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::MfaTotpDeviceSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_policies(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
To determine which policies apply to a particular group or compartment, you must view the individual statements inside all your policies. There isn’t a way to automatically obtain that information via the API.
4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 |
# File 'lib/oci/identity/identity_client.rb', line 4263 def list_policies(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_policies.' if logger raise "Missing the required parameter 'compartment_id' when calling list_policies." if compartment_id.nil? path = '/policies/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_policies') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::Policy>' ) end # rubocop:enable Metrics/BlockLength end |
#list_region_subscriptions(tenancy_id, opts = {}) ⇒ Response
Lists the region subscriptions for the specified tenancy.
4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 |
# File 'lib/oci/identity/identity_client.rb', line 4317 def list_region_subscriptions(tenancy_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_region_subscriptions.' if logger raise "Missing the required parameter 'tenancy_id' when calling list_region_subscriptions." if tenancy_id.nil? raise "Parameter value for 'tenancy_id' must not be blank" if OCI::Internal::Util.blank_string?(tenancy_id) path = '/tenancies/{tenancyId}/regionSubscriptions'.sub('{tenancyId}', tenancy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_region_subscriptions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::RegionSubscription>' ) end # rubocop:enable Metrics/BlockLength end |
#list_regions(opts = {}) ⇒ Response
Lists all the regions offered by Oracle Cloud Infrastructure.
4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 |
# File 'lib/oci/identity/identity_client.rb', line 4369 def list_regions(opts = {}) logger.debug 'Calling operation IdentityClient#list_regions.' if logger path = '/regions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_regions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::Region>' ) end # rubocop:enable Metrics/BlockLength end |
#list_smtp_credentials(user_id, opts = {}) ⇒ Response
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.
4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 |
# File 'lib/oci/identity/identity_client.rb', line 4422 def list_smtp_credentials(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_smtp_credentials.' if logger raise "Missing the required parameter 'user_id' when calling list_smtp_credentials." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/smtpCredentials/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_smtp_credentials') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::SmtpCredentialSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_swift_passwords(user_id, opts = {}) ⇒ Response
**Deprecated. Use list_auth_tokens 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.
4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 |
# File 'lib/oci/identity/identity_client.rb', line 4479 def list_swift_passwords(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_swift_passwords.' if logger raise "Missing the required parameter 'user_id' when calling list_swift_passwords." if user_id.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/swiftPasswords/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_swift_passwords') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::SwiftPassword>' ) end # rubocop:enable Metrics/BlockLength end |
#list_tag_defaults(opts = {}) ⇒ Response
Lists the tag defaults for tag definitions in the specified compartment.
4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 |
# File 'lib/oci/identity/identity_client.rb', line 4543 def list_tag_defaults(opts = {}) logger.debug 'Calling operation IdentityClient#list_tag_defaults.' if logger if opts[:lifecycle_state] && !OCI::Identity::Models::TagDefaultSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::TagDefaultSummary::LIFECYCLE_STATE_ENUM.' end path = '/tagDefaults' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:id] = opts[:id] if opts[:id] query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:tagDefinitionId] = opts[:tag_definition_id] if opts[:tag_definition_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_tag_defaults') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::TagDefaultSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_tag_namespaces(compartment_id, opts = {}) ⇒ Response
Lists the tag namespaces in the specified compartment.
4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 |
# File 'lib/oci/identity/identity_client.rb', line 4613 def list_tag_namespaces(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_tag_namespaces.' if logger raise "Missing the required parameter 'compartment_id' when calling list_tag_namespaces." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Identity::Models::TagNamespace::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::TagNamespace::LIFECYCLE_STATE_ENUM.' end path = '/tagNamespaces' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:includeSubcompartments] = opts[:include_subcompartments] if !opts[:include_subcompartments].nil? query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_tag_namespaces') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::TagNamespaceSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_tags(tag_namespace_id, opts = {}) ⇒ Response
Lists the tag definitions in the specified tag namespace.
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 |
# File 'lib/oci/identity/identity_client.rb', line 4680 def (tag_namespace_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_tags.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling list_tags." if tag_namespace_id.nil? if opts[:lifecycle_state] && !OCI::Identity::Models::Tag::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::Tag::LIFECYCLE_STATE_ENUM.' end raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) path = '/tagNamespaces/{tagNamespaceId}/tags'.sub('{tagNamespaceId}', tag_namespace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_tags') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::TagSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_user_group_memberships(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five)). You must also then filter the list in one of these ways:
-
You can limit the results to just the memberships for a given user by specifying a ‘userId`.
-
Similarly, you can limit the results to just the memberships for a given group by specifying a ‘groupId`.
-
You can set both the ‘userId` and `groupId` to determine if the specified user is in the specified group.
If the answer is no, the response is an empty list.
-
Although`userId` and ‘groupId` are not indvidually required, you must set one of them.
4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 |
# File 'lib/oci/identity/identity_client.rb', line 4755 def list_user_group_memberships(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_user_group_memberships.' if logger raise "Missing the required parameter 'compartment_id' when calling list_user_group_memberships." if compartment_id.nil? path = '/userGroupMemberships/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:userId] = opts[:user_id] if opts[:user_id] query_params[:groupId] = opts[:group_id] if opts[:group_id] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_user_group_memberships') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::UserGroupMembership>' ) end # rubocop:enable Metrics/BlockLength end |
#list_users(compartment_id, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 |
# File 'lib/oci/identity/identity_client.rb', line 4822 def list_users(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_users.' if logger raise "Missing the required parameter 'compartment_id' when calling list_users." if compartment_id.nil? path = '/users/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:identityProviderId] = opts[:identity_provider_id] if opts[:identity_provider_id] query_params[:externalIdentifier] = opts[:external_identifier] if opts[:external_identifier] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_users') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::User>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in compartment.
4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 |
# File 'lib/oci/identity/identity_client.rb', line 4884 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? path = '/workRequests/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:resourceIdentifier] = opts[:resource_identifier] if opts[:resource_identifier] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#list_work_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Identity::Models::WorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
102 103 104 |
# File 'lib/oci/identity/identity_client.rb', line 102 def logger @api_client.config.logger end |
#move_compartment(compartment_id, move_compartment_details, opts = {}) ⇒ Response
Move the compartment tree to a different parent compartment.
4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 |
# File 'lib/oci/identity/identity_client.rb', line 4953 def move_compartment(compartment_id, move_compartment_details, opts = {}) logger.debug 'Calling operation IdentityClient#move_compartment.' if logger raise "Missing the required parameter 'compartment_id' when calling move_compartment." if compartment_id.nil? raise "Missing the required parameter 'move_compartment_details' when calling move_compartment." if move_compartment_details.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/compartments/{compartmentId}/actions/moveCompartment'.sub('{compartmentId}', compartment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(move_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#move_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_user_from_group(user_group_membership_id, opts = {}) ⇒ Response
Removes a user from a group by deleting the corresponding ‘UserGroupMembership`.
5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 |
# File 'lib/oci/identity/identity_client.rb', line 5012 def remove_user_from_group(user_group_membership_id, opts = {}) logger.debug 'Calling operation IdentityClient#remove_user_from_group.' if logger raise "Missing the required parameter 'user_group_membership_id' when calling remove_user_from_group." if user_group_membership_id.nil? raise "Parameter value for 'user_group_membership_id' must not be blank" if OCI::Internal::Util.blank_string?(user_group_membership_id) path = '/userGroupMemberships/{userGroupMembershipId}'.sub('{userGroupMembershipId}', user_group_membership_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#remove_user_from_group') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#reset_idp_scim_client(identity_provider_id, opts = {}) ⇒ Response
Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.
5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 |
# File 'lib/oci/identity/identity_client.rb', line 5065 def reset_idp_scim_client(identity_provider_id, opts = {}) logger.debug 'Calling operation IdentityClient#reset_idp_scim_client.' if logger raise "Missing the required parameter 'identity_provider_id' when calling reset_idp_scim_client." if identity_provider_id.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}/actions/resetScimClient/'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#reset_idp_scim_client') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::ScimClientCredentials' ) end # rubocop:enable Metrics/BlockLength end |
#update_auth_token(user_id, auth_token_id, update_auth_token_details, opts = {}) ⇒ Response
Updates the specified auth token’s description.
5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 |
# File 'lib/oci/identity/identity_client.rb', line 5124 def update_auth_token(user_id, auth_token_id, update_auth_token_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_auth_token.' if logger raise "Missing the required parameter 'user_id' when calling update_auth_token." if user_id.nil? raise "Missing the required parameter 'auth_token_id' when calling update_auth_token." if auth_token_id.nil? raise "Missing the required parameter 'update_auth_token_details' when calling update_auth_token." if update_auth_token_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(auth_token_id) path = '/users/{userId}/authTokens/{authTokenId}'.sub('{userId}', user_id.to_s).sub('{authTokenId}', auth_token_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_auth_token_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_auth_token') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::AuthToken' ) end # rubocop:enable Metrics/BlockLength end |
#update_authentication_policy(compartment_id, update_authentication_policy_details, opts = {}) ⇒ Response
Updates authentication policy for the specified tenancy
5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 |
# File 'lib/oci/identity/identity_client.rb', line 5185 def update_authentication_policy(compartment_id, update_authentication_policy_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_authentication_policy.' if logger raise "Missing the required parameter 'compartment_id' when calling update_authentication_policy." if compartment_id.nil? raise "Missing the required parameter 'update_authentication_policy_details' when calling update_authentication_policy." if update_authentication_policy_details.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/authenticationPolicies/{compartmentId}'.sub('{compartmentId}', compartment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_authentication_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_authentication_policy') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::AuthenticationPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#update_compartment(compartment_id, update_compartment_details, opts = {}) ⇒ Response
Updates the specified compartment’s description or name. You can’t update the root compartment.
5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 |
# File 'lib/oci/identity/identity_client.rb', line 5243 def update_compartment(compartment_id, update_compartment_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_compartment.' if logger raise "Missing the required parameter 'compartment_id' when calling update_compartment." if compartment_id.nil? raise "Missing the required parameter 'update_compartment_details' when calling update_compartment." if update_compartment_details.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/compartments/{compartmentId}'.sub('{compartmentId}', compartment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_compartment') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Compartment' ) end # rubocop:enable Metrics/BlockLength end |
#update_customer_secret_key(user_id, customer_secret_key_id, update_customer_secret_key_details, opts = {}) ⇒ Response
Updates the specified secret key’s description.
5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 |
# File 'lib/oci/identity/identity_client.rb', line 5303 def update_customer_secret_key(user_id, customer_secret_key_id, update_customer_secret_key_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_customer_secret_key.' if logger raise "Missing the required parameter 'user_id' when calling update_customer_secret_key." if user_id.nil? raise "Missing the required parameter 'customer_secret_key_id' when calling update_customer_secret_key." if customer_secret_key_id.nil? raise "Missing the required parameter 'update_customer_secret_key_details' when calling update_customer_secret_key." if update_customer_secret_key_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(customer_secret_key_id) path = '/users/{userId}/customerSecretKeys/{customerSecretKeyId}'.sub('{userId}', user_id.to_s).sub('{customerSecretKeyId}', customer_secret_key_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_customer_secret_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_customer_secret_key') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::CustomerSecretKeySummary' ) end # rubocop:enable Metrics/BlockLength end |
#update_dynamic_group(dynamic_group_id, update_dynamic_group_details, opts = {}) ⇒ Response
Updates the specified dynamic group.
5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 |
# File 'lib/oci/identity/identity_client.rb', line 5363 def update_dynamic_group(dynamic_group_id, update_dynamic_group_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_dynamic_group.' if logger raise "Missing the required parameter 'dynamic_group_id' when calling update_dynamic_group." if dynamic_group_id.nil? raise "Missing the required parameter 'update_dynamic_group_details' when calling update_dynamic_group." if update_dynamic_group_details.nil? raise "Parameter value for 'dynamic_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_group_id) path = '/dynamicGroups/{dynamicGroupId}'.sub('{dynamicGroupId}', dynamic_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_dynamic_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_dynamic_group') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::DynamicGroup' ) end # rubocop:enable Metrics/BlockLength end |
#update_group(group_id, update_group_details, opts = {}) ⇒ Response
Updates the specified group.
5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 |
# File 'lib/oci/identity/identity_client.rb', line 5421 def update_group(group_id, update_group_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_group.' if logger raise "Missing the required parameter 'group_id' when calling update_group." if group_id.nil? raise "Missing the required parameter 'update_group_details' when calling update_group." if update_group_details.nil? raise "Parameter value for 'group_id' must not be blank" if OCI::Internal::Util.blank_string?(group_id) path = '/groups/{groupId}'.sub('{groupId}', group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_group') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Group' ) end # rubocop:enable Metrics/BlockLength end |
#update_identity_provider(identity_provider_id, update_identity_provider_details, opts = {}) ⇒ Response
Updates the specified identity provider.
5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 |
# File 'lib/oci/identity/identity_client.rb', line 5479 def update_identity_provider(identity_provider_id, update_identity_provider_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_identity_provider.' if logger raise "Missing the required parameter 'identity_provider_id' when calling update_identity_provider." if identity_provider_id.nil? raise "Missing the required parameter 'update_identity_provider_details' when calling update_identity_provider." if update_identity_provider_details.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) path = '/identityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_identity_provider_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_identity_provider') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::IdentityProvider' ) end # rubocop:enable Metrics/BlockLength end |
#update_idp_group_mapping(identity_provider_id, mapping_id, update_idp_group_mapping_details, opts = {}) ⇒ Response
Updates the specified group mapping.
5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 |
# File 'lib/oci/identity/identity_client.rb', line 5538 def update_idp_group_mapping(identity_provider_id, mapping_id, update_idp_group_mapping_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_idp_group_mapping.' if logger raise "Missing the required parameter 'identity_provider_id' when calling update_idp_group_mapping." if identity_provider_id.nil? raise "Missing the required parameter 'mapping_id' when calling update_idp_group_mapping." if mapping_id.nil? raise "Missing the required parameter 'update_idp_group_mapping_details' when calling update_idp_group_mapping." if update_idp_group_mapping_details.nil? raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id) raise "Parameter value for 'mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(mapping_id) path = '/identityProviders/{identityProviderId}/groupMappings/{mappingId}'.sub('{identityProviderId}', identity_provider_id.to_s).sub('{mappingId}', mapping_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_idp_group_mapping_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_idp_group_mapping') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::IdpGroupMapping' ) end # rubocop:enable Metrics/BlockLength end |
#update_policy(policy_id, update_policy_details, opts = {}) ⇒ Response
Updates the specified policy. You can update the description or the policy statements themselves.
Policy changes take effect typically within 10 seconds.
5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 |
# File 'lib/oci/identity/identity_client.rb', line 5601 def update_policy(policy_id, update_policy_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_policy.' if logger raise "Missing the required parameter 'policy_id' when calling update_policy." if policy_id.nil? raise "Missing the required parameter 'update_policy_details' when calling update_policy." if update_policy_details.nil? raise "Parameter value for 'policy_id' must not be blank" if OCI::Internal::Util.blank_string?(policy_id) path = '/policies/{policyId}'.sub('{policyId}', policy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_policy') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Policy' ) end # rubocop:enable Metrics/BlockLength end |
#update_smtp_credential(user_id, smtp_credential_id, update_smtp_credential_details, opts = {}) ⇒ Response
Updates the specified SMTP credential’s description.
5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 |
# File 'lib/oci/identity/identity_client.rb', line 5661 def update_smtp_credential(user_id, smtp_credential_id, update_smtp_credential_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_smtp_credential.' if logger raise "Missing the required parameter 'user_id' when calling update_smtp_credential." if user_id.nil? raise "Missing the required parameter 'smtp_credential_id' when calling update_smtp_credential." if smtp_credential_id.nil? raise "Missing the required parameter 'update_smtp_credential_details' when calling update_smtp_credential." if update_smtp_credential_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(smtp_credential_id) path = '/users/{userId}/smtpCredentials/{smtpCredentialId}'.sub('{userId}', user_id.to_s).sub('{smtpCredentialId}', smtp_credential_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_smtp_credential_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_smtp_credential') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::SmtpCredentialSummary' ) end # rubocop:enable Metrics/BlockLength end |
#update_swift_password(user_id, swift_password_id, update_swift_password_details, opts = {}) ⇒ Response
**Deprecated. Use update_auth_token instead.**
Updates the specified Swift password’s description.
5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 |
# File 'lib/oci/identity/identity_client.rb', line 5725 def update_swift_password(user_id, swift_password_id, update_swift_password_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_swift_password.' if logger raise "Missing the required parameter 'user_id' when calling update_swift_password." if user_id.nil? raise "Missing the required parameter 'swift_password_id' when calling update_swift_password." if swift_password_id.nil? raise "Missing the required parameter 'update_swift_password_details' when calling update_swift_password." if update_swift_password_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) raise "Parameter value for 'swift_password_id' must not be blank" if OCI::Internal::Util.blank_string?(swift_password_id) path = '/users/{userId}/swiftPasswords/{swiftPasswordId}'.sub('{userId}', user_id.to_s).sub('{swiftPasswordId}', swift_password_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_swift_password_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_swift_password') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::SwiftPassword' ) end # rubocop:enable Metrics/BlockLength end |
#update_tag(tag_namespace_id, tag_name, update_tag_details, opts = {}) ⇒ Response
Updates the the specified tag definition. You can update ‘description`, and `isRetired`.
5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 |
# File 'lib/oci/identity/identity_client.rb', line 5789 def update_tag(tag_namespace_id, tag_name, update_tag_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_tag.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling update_tag." if tag_namespace_id.nil? raise "Missing the required parameter 'tag_name' when calling update_tag." if tag_name.nil? raise "Missing the required parameter 'update_tag_details' when calling update_tag." if update_tag_details.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) raise "Parameter value for 'tag_name' must not be blank" if OCI::Internal::Util.blank_string?(tag_name) path = '/tagNamespaces/{tagNamespaceId}/tags/{tagName}'.sub('{tagNamespaceId}', tag_namespace_id.to_s).sub('{tagName}', tag_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_tag_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_tag') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::Tag' ) end # rubocop:enable Metrics/BlockLength end |
#update_tag_default(tag_default_id, update_tag_default_details, opts = {}) ⇒ Response
Updates the specified tag default. You can update the following field: ‘value`.
5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 |
# File 'lib/oci/identity/identity_client.rb', line 5853 def update_tag_default(tag_default_id, update_tag_default_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_tag_default.' if logger raise "Missing the required parameter 'tag_default_id' when calling update_tag_default." if tag_default_id.nil? raise "Missing the required parameter 'update_tag_default_details' when calling update_tag_default." if update_tag_default_details.nil? raise "Parameter value for 'tag_default_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_default_id) path = '/tagDefaults/{tagDefaultId}'.sub('{tagDefaultId}', tag_default_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_tag_default_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_tag_default') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::TagDefault' ) end # rubocop:enable Metrics/BlockLength end |
#update_tag_namespace(tag_namespace_id, update_tag_namespace_details, opts = {}) ⇒ Response
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 update_tag. For more information about retiring tag namespaces, see [Retiring Key Definitions and Namespace Definitions](docs.cloud.oracle.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.
5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 |
# File 'lib/oci/identity/identity_client.rb', line 5919 def update_tag_namespace(tag_namespace_id, update_tag_namespace_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_tag_namespace.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling update_tag_namespace." if tag_namespace_id.nil? raise "Missing the required parameter 'update_tag_namespace_details' when calling update_tag_namespace." if update_tag_namespace_details.nil? raise "Parameter value for 'tag_namespace_id' must not be blank" if OCI::Internal::Util.blank_string?(tag_namespace_id) path = '/tagNamespaces/{tagNamespaceId}'.sub('{tagNamespaceId}', tag_namespace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_tag_namespace_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_tag_namespace') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::TagNamespace' ) end # rubocop:enable Metrics/BlockLength end |
#update_user(user_id, update_user_details, opts = {}) ⇒ Response
Updates the description of the specified user.
5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 |
# File 'lib/oci/identity/identity_client.rb', line 5977 def update_user(user_id, update_user_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_user.' if logger raise "Missing the required parameter 'user_id' when calling update_user." if user_id.nil? raise "Missing the required parameter 'update_user_details' when calling update_user." if update_user_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_user_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_user') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::User' ) end # rubocop:enable Metrics/BlockLength end |
#update_user_capabilities(user_id, update_user_capabilities_details, opts = {}) ⇒ Response
Updates the capabilities of the specified user.
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 |
# File 'lib/oci/identity/identity_client.rb', line 6036 def update_user_capabilities(user_id, update_user_capabilities_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_user_capabilities.' if logger raise "Missing the required parameter 'user_id' when calling update_user_capabilities." if user_id.nil? raise "Missing the required parameter 'update_user_capabilities_details' when calling update_user_capabilities." if update_user_capabilities_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/capabilities/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_user_capabilities_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_user_capabilities') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::User' ) end # rubocop:enable Metrics/BlockLength end |
#update_user_state(user_id, update_state_details, opts = {}) ⇒ Response
Updates the state of the specified user.
6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 |
# File 'lib/oci/identity/identity_client.rb', line 6095 def update_user_state(user_id, update_state_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_user_state.' if logger raise "Missing the required parameter 'user_id' when calling update_user_state." if user_id.nil? raise "Missing the required parameter 'update_state_details' when calling update_user_state." if update_state_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/state/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_state_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_user_state') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::User' ) end # rubocop:enable Metrics/BlockLength end |
#upload_api_key(user_id, create_api_key_details, opts = {}) ⇒ Response
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.
6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 |
# File 'lib/oci/identity/identity_client.rb', line 6170 def upload_api_key(user_id, create_api_key_details, opts = {}) logger.debug 'Calling operation IdentityClient#upload_api_key.' if logger raise "Missing the required parameter 'user_id' when calling upload_api_key." if user_id.nil? raise "Missing the required parameter 'create_api_key_details' when calling upload_api_key." if create_api_key_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/apiKeys/'.sub('{userId}', user_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_api_key_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#upload_api_key') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Identity::Models::ApiKey' ) end # rubocop:enable Metrics/BlockLength end |