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.
-
#assemble_effective_tag_set(compartment_id, opts = {}) ⇒ Response
Assembles tag defaults in the specified compartment and any parent compartments to determine the tags to apply.
-
#bulk_delete_resources(compartment_id, bulk_delete_resources_details, opts = {}) ⇒ Response
Bulk delete resources in the compartment.
-
#bulk_delete_tags(bulk_delete_tags_details, opts = {}) ⇒ Response
Deletes the specified tag key definitions.
-
#bulk_move_resources(compartment_id, bulk_move_resources_details, opts = {}) ⇒ Response
Bulk move resources in the compartment.
-
#cascade_delete_tag_namespace(tag_namespace_id, opts = {}) ⇒ Response
Deletes the specified tag namespace.
-
#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_network_source(create_network_source_details, opts = {}) ⇒ Response
Creates a new network source in your tenancy.
-
#create_o_auth_client_credential(user_id, create_o_auth2_client_credential_details, opts = {}) ⇒ Response
Creates Oauth token 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_network_source(network_source_id, opts = {}) ⇒ Response
Deletes the specified network source.
-
#delete_o_auth_client_credential(user_id, oauth2_client_credential_id, opts = {}) ⇒ Response
Delete Oauth token for the 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 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
Deletes 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_network_source(network_source_id, opts = {}) ⇒ Response
Gets the specified network source’s information.
-
#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_tagging_work_request(work_request_id, opts = {}) ⇒ Response
Gets details on a specified work request.
-
#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_bulk_action_resource_types(bulk_action_type, opts = {}) ⇒ Response
Lists the resource types supported by compartment bulk actions.
-
#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_network_sources(compartment_id, opts = {}) ⇒ Response
Lists the network sources in your tenancy.
-
#list_o_auth_client_credentials(user_id, opts = {}) ⇒ Response
List of Oauth tokens for the 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_tagging_work_request_errors(work_request_id, opts = {}) ⇒ Response
Gets the errors for a work request.
-
#list_tagging_work_request_logs(work_request_id, opts = {}) ⇒ Response
Gets the logs for a work request.
-
#list_tagging_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the tagging work requests in 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 to a different parent compartment in the same tenancy.
-
#recover_compartment(compartment_id, opts = {}) ⇒ Response
Recover the compartment from DELETED state to ACTIVE state.
-
#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_network_source(network_source_id, update_network_source_details, opts = {}) ⇒ Response
Updates the specified network source.
-
#update_o_auth_client_credential(user_id, oauth2_client_credential_id, update_o_auth2_client_credential_details, opts = {}) ⇒ Response
Updates Oauth token for the user.
-
#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 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.
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 |
# File 'lib/oci/identity/identity_client.rb', line 53 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # 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.validate_and_build_config_with_signer(config, signer) 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.
13 14 15 |
# File 'lib/oci/identity/identity_client.rb', line 13 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
17 18 19 |
# File 'lib/oci/identity/identity_client.rb', line 17 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
27 28 29 |
# File 'lib/oci/identity/identity_client.rb', line 27 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
23 24 25 |
# File 'lib/oci/identity/identity_client.rb', line 23 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.
129 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 |
# File 'lib/oci/identity/identity_client.rb', line 129 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.
196 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 |
# File 'lib/oci/identity/identity_client.rb', line 196 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 |
#assemble_effective_tag_set(compartment_id, opts = {}) ⇒ Response
Assembles tag defaults in the specified compartment and any parent compartments to determine the tags to apply. Tag defaults from parent compartments do not override tag defaults referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults includes all tag defaults from the current compartment back to the root compartment.
255 256 257 258 259 260 261 262 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 |
# File 'lib/oci/identity/identity_client.rb', line 255 def assemble_effective_tag_set(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#assemble_effective_tag_set.' if logger raise "Missing the required parameter 'compartment_id' when calling assemble_effective_tag_set." if compartment_id.nil? 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/actions/assembleEffectiveTagSet' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_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#assemble_effective_tag_set') 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 |
#bulk_delete_resources(compartment_id, bulk_delete_resources_details, opts = {}) ⇒ Response
Bulk delete resources in the compartment. All resources must be in the same compartment. This API can only be invoked from tenancy’s home region.
323 324 325 326 327 328 329 330 331 332 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 |
# File 'lib/oci/identity/identity_client.rb', line 323 def bulk_delete_resources(compartment_id, bulk_delete_resources_details, opts = {}) logger.debug 'Calling operation IdentityClient#bulk_delete_resources.' if logger raise "Missing the required parameter 'compartment_id' when calling bulk_delete_resources." if compartment_id.nil? raise "Missing the required parameter 'bulk_delete_resources_details' when calling bulk_delete_resources." if bulk_delete_resources_details.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/compartments/{compartmentId}/actions/bulkDeleteResources'.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[:'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(bulk_delete_resources_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#bulk_delete_resources') 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 |
#bulk_delete_tags(bulk_delete_tags_details, opts = {}) ⇒ Response
Deletes the specified tag key definitions. This operation triggers a process that removes the tags from all resources in your tenancy.
The following actions happen immediately: u00A0
* If the tag is a cost-tracking tag, the tag no longer counts against your
10 cost-tracking tags limit, even if you do not disable the tag before running this operation.
* If the tag is used with dynamic groups, the rules that contain the tag are no longer
evaluated against the tag.
After you start this operation, the state of the tag changes to DELETING, and tag removal from resources begins. This process can take up to 48 hours depending on the number of resources that are tagged and the regions in which those resources reside.
When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state changes to DELETED, you can use the same tag name again.
After you start this operation, you cannot start either the delete_tag or the cascade_delete_tag_namespace operation until this process completes.
In order to delete tags, you must first retire the tags. Use update_tag to retire a tag.
407 408 409 410 411 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 |
# File 'lib/oci/identity/identity_client.rb', line 407 def (, opts = {}) logger.debug 'Calling operation IdentityClient#bulk_delete_tags.' if logger raise "Missing the required parameter 'bulk_delete_tags_details' when calling bulk_delete_tags." if .nil? path = '/tags/actions/bulkDelete' 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[:'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() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#bulk_delete_tags') 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 |
#bulk_move_resources(compartment_id, bulk_move_resources_details, opts = {}) ⇒ Response
Bulk move resources in the compartment. All resources must be in the same compartment. This API can only be invoked from tenancy’s home region.
471 472 473 474 475 476 477 478 479 480 481 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 |
# File 'lib/oci/identity/identity_client.rb', line 471 def bulk_move_resources(compartment_id, bulk_move_resources_details, opts = {}) logger.debug 'Calling operation IdentityClient#bulk_move_resources.' if logger raise "Missing the required parameter 'compartment_id' when calling bulk_move_resources." if compartment_id.nil? raise "Missing the required parameter 'bulk_move_resources_details' when calling bulk_move_resources." if bulk_move_resources_details.nil? raise "Parameter value for 'compartment_id' must not be blank" if OCI::Internal::Util.blank_string?(compartment_id) path = '/compartments/{compartmentId}/actions/bulkMoveResources'.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[:'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(bulk_move_resources_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#bulk_move_resources') 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 |
#cascade_delete_tag_namespace(tag_namespace_id, opts = {}) ⇒ Response
Deletes the specified tag namespace. This operation triggers a process that removes all of the tags defined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace.
After you start the delete operation:
* New tag key definitions cannot be created under the namespace.
* The state of the tag namespace changes to DELETING.
* Tag removal from the resources begins.
This process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources that are tagged, and the locations of the regions in which those resources reside.
After all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace changes its state to DELETED, you can use the name of the deleted tag namespace again.
After you start this operation, you cannot start either the delete_tag or the bulk_delete_tags operation until this process completes.
To delete a tag namespace, you must first retire it. Use update_tag_namespace to retire a tag namespace.
558 559 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 558 def cascade_delete_tag_namespace(tag_namespace_id, opts = {}) logger.debug 'Calling operation IdentityClient#cascade_delete_tag_namespace.' if logger raise "Missing the required parameter 'tag_namespace_id' when calling cascade_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}/actions/cascadeDelete'.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] 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#cascade_delete_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 ) 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.
626 627 628 629 630 631 632 633 634 635 636 637 638 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 |
# File 'lib/oci/identity/identity_client.rb', line 626 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.
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
# File 'lib/oci/identity/identity_client.rb', line 696 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.
775 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 |
# File 'lib/oci/identity/identity_client.rb', line 775 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.
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 875 876 877 878 879 880 881 882 883 |
# File 'lib/oci/identity/identity_client.rb', line 845 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.
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 |
# File 'lib/oci/identity/identity_client.rb', line 923 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.
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 |
# File 'lib/oci/identity/identity_client.rb', line 1002 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.
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 |
# File 'lib/oci/identity/identity_client.rb', line 1078 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.
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 |
# File 'lib/oci/identity/identity_client.rb', line 1139 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.
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 |
# File 'lib/oci/identity/identity_client.rb', line 1200 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_network_source(create_network_source_details, opts = {}) ⇒ Response
Creates a new network source in your tenancy.
You must specify your tenancy’s OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see [Resource Identifiers](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a name for the network source, which must be unique across all network sources in your tenancy, and cannot be changed. You can use this name or the OCID when writing policies that apply to the network source. For more information about policies, see [How Policies Work](docs.cloud.oracle.com/Content/Identity/Concepts/policies.htm).
You must also specify a description for the network source (although it can be an empty string). It does not have to be unique, and you can change it anytime with update_network_source.
After you send your request, the new object’s ‘lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed IP address specified in your network source. For more information, see [Managing Network Sources](docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'lib/oci/identity/identity_client.rb', line 1280 def create_network_source(create_network_source_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_network_source.' if logger raise "Missing the required parameter 'create_network_source_details' when calling create_network_source." if create_network_source_details.nil? path = '/networkSources' 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_network_source_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_network_source') 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::NetworkSources' ) end # rubocop:enable Metrics/BlockLength end |
#create_o_auth_client_credential(user_id, create_o_auth2_client_credential_details, opts = {}) ⇒ Response
Creates Oauth token for the user
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'lib/oci/identity/identity_client.rb', line 1340 def create_o_auth_client_credential(user_id, create_o_auth2_client_credential_details, opts = {}) logger.debug 'Calling operation IdentityClient#create_o_auth_client_credential.' if logger raise "Missing the required parameter 'user_id' when calling create_o_auth_client_credential." if user_id.nil? raise "Missing the required parameter 'create_o_auth2_client_credential_details' when calling create_o_auth_client_credential." if create_o_auth2_client_credential_details.nil? raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/oauth2ClientCredentials'.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_o_auth2_client_credential_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#create_o_auth_client_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::OAuth2ClientCredential' ) 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).
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'lib/oci/identity/identity_client.rb', line 1411 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.
1487 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 |
# File 'lib/oci/identity/identity_client.rb', line 1487 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.
1547 1548 1549 1550 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 |
# File 'lib/oci/identity/identity_client.rb', line 1547 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.
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 1648 1649 1650 |
# File 'lib/oci/identity/identity_client.rb', line 1612 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.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 |
# File 'lib/oci/identity/identity_client.rb', line 1685 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.
The tag requires either the OCID or the name of the tag namespace that will contain this tag definition.
You must specify a name for the tag, which must be unique across all tags in the tag namespace and cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters. Names are case insensitive. That means, for example, "myTag" and "mytag" are not allowed in the same namespace. If you specify a name that’s already in use in the tag namespace, a 409 error is returned.
The tag must have a description. It does not have to be unique, and you can change it with update_tag.
The tag must have a value type, which is specified with a validator. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. Lists are validiated.
-
If no ‘validator` is set, the user applying the tag to a resource can type in a static
value or leave the tag value empty.
-
If a ‘validator` is set, the user applying the tag to a resource must select from a list
of values that you supply with enum_tag_definition_validator.
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 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 |
# File 'lib/oci/identity/identity_client.rb', line 1769 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.
If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.
-
If the ‘isRequired` flag is set to "true", the value is set during resource creation.
-
If the ‘isRequired` flag is set to "false", the value you enter is set during resource creation.
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 1875 1876 1877 |
# File 'lib/oci/identity/identity_client.rb', line 1840 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.
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 |
# File 'lib/oci/identity/identity_client.rb', line 1913 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.
2006 2007 2008 2009 2010 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 |
# File 'lib/oci/identity/identity_client.rb', line 2006 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.
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 2104 2105 2106 |
# File 'lib/oci/identity/identity_client.rb', line 2069 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.
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 2163 2164 2165 |
# File 'lib/oci/identity/identity_client.rb', line 2128 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.
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 |
# File 'lib/oci/identity/identity_client.rb', line 2186 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.
2243 2244 2245 2246 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 |
# File 'lib/oci/identity/identity_client.rb', line 2243 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.
2301 2302 2303 2304 2305 2306 2307 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 |
# File 'lib/oci/identity/identity_client.rb', line 2301 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.
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 |
# File 'lib/oci/identity/identity_client.rb', line 2357 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).
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 |
# File 'lib/oci/identity/identity_client.rb', line 2414 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.
2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 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 |
# File 'lib/oci/identity/identity_client.rb', line 2470 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.
2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 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 |
# File 'lib/oci/identity/identity_client.rb', line 2529 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_network_source(network_source_id, opts = {}) ⇒ Response
Deletes the specified network source
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 |
# File 'lib/oci/identity/identity_client.rb', line 2587 def delete_network_source(network_source_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_network_source.' if logger raise "Missing the required parameter 'network_source_id' when calling delete_network_source." if network_source_id.nil? raise "Parameter value for 'network_source_id' must not be blank" if OCI::Internal::Util.blank_string?(network_source_id) path = '/networkSources/{networkSourceId}'.sub('{networkSourceId}', network_source_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_network_source') 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_o_auth_client_credential(user_id, oauth2_client_credential_id, opts = {}) ⇒ Response
Delete Oauth token for the user
2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 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 |
# File 'lib/oci/identity/identity_client.rb', line 2644 def delete_o_auth_client_credential(user_id, oauth2_client_credential_id, opts = {}) logger.debug 'Calling operation IdentityClient#delete_o_auth_client_credential.' if logger raise "Missing the required parameter 'user_id' when calling delete_o_auth_client_credential." if user_id.nil? raise "Missing the required parameter 'oauth2_client_credential_id' when calling delete_o_auth_client_credential." if oauth2_client_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 'oauth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(oauth2_client_credential_id) path = '/users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}'.sub('{userId}', user_id.to_s).sub('{oauth2ClientCredentialId}', oauth2_client_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_o_auth_client_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_policy(policy_id, opts = {}) ⇒ Response
Deletes the specified policy. The deletion takes effect typically within 10 seconds.
2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 |
# File 'lib/oci/identity/identity_client.rb', line 2701 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.
2758 2759 2760 2761 2762 2763 2764 2765 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 |
# File 'lib/oci/identity/identity_client.rb', line 2758 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.
2819 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 |
# File 'lib/oci/identity/identity_client.rb', line 2819 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 specified tag definition. This operation triggers a process that removes the tag from all resources in your tenancy.
These things happen immediately: u00A0
* If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking
tags limit, whether you first disabled it or not.
* If the tag was used with dynamic groups, none of the rules that contain the tag will
be evaluated against the tag.
When you start the delete operation, the state of the tag changes to DELETING and tag removal from resources begins. This can take up to 48 hours depending on the number of resources that were tagged as well as the regions in which those resources reside.
When all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag changes its state to DELETED, you can use the same tag name again.
After you start this operation, you cannot start either the bulk_delete_tags or the cascade_delete_tag_namespace operation until this process completes.
To delete a tag, you must first retire it. Use update_tag to retire a tag.
2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 |
# File 'lib/oci/identity/identity_client.rb', line 2900 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.
2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 |
# File 'lib/oci/identity/identity_client.rb', line 2961 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
Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation to delete a tag namespace that contains tag definitions, first delete all of its tag definitions.
Use cascade_delete_tag_namespace to delete a tag namespace along with all of the tag definitions contained within that namespace.
Use delete_tag to delete a tag definition.
3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 |
# File 'lib/oci/identity/identity_client.rb', line 3028 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.
3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 |
# File 'lib/oci/identity/identity_client.rb', line 3084 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.
3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 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 |
# File 'lib/oci/identity/identity_client.rb', line 3141 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).
3198 3199 3200 3201 3202 3203 3204 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 |
# File 'lib/oci/identity/identity_client.rb', line 3198 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.
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 3294 |
# File 'lib/oci/identity/identity_client.rb', line 3259 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.
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_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.
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 3404 3405 3406 |
# File 'lib/oci/identity/identity_client.rb', line 3371 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.
3424 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 |
# File 'lib/oci/identity/identity_client.rb', line 3424 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.
3478 3479 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 3478 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.
3535 3536 3537 3538 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 |
# File 'lib/oci/identity/identity_client.rb', line 3535 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_network_source(network_source_id, opts = {}) ⇒ Response
Gets the specified network source’s information.
3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 |
# File 'lib/oci/identity/identity_client.rb', line 3591 def get_network_source(network_source_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_network_source.' if logger raise "Missing the required parameter 'network_source_id' when calling get_network_source." if network_source_id.nil? raise "Parameter value for 'network_source_id' must not be blank" if OCI::Internal::Util.blank_string?(network_source_id) path = '/networkSources/{networkSourceId}'.sub('{networkSourceId}', network_source_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_network_source') 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::NetworkSources' ) end # rubocop:enable Metrics/BlockLength end |
#get_policy(policy_id, opts = {}) ⇒ Response
Gets the specified policy’s information.
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 3673 3674 3675 3676 3677 3678 3679 |
# File 'lib/oci/identity/identity_client.rb', line 3644 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.
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 3733 3734 3735 3736 3737 |
# File 'lib/oci/identity/identity_client.rb', line 3700 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.
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 3787 3788 3789 3790 3791 |
# File 'lib/oci/identity/identity_client.rb', line 3756 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.
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 |
# File 'lib/oci/identity/identity_client.rb', line 3811 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_tagging_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.
3866 3867 3868 3869 3870 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 |
# File 'lib/oci/identity/identity_client.rb', line 3866 def get_tagging_work_request(work_request_id, opts = {}) logger.debug 'Calling operation IdentityClient#get_tagging_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_tagging_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 = '/taggingWorkRequests/{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_tagging_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::TaggingWorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#get_tenancy(tenancy_id, opts = {}) ⇒ Response
Get the specified tenancy’s information.
3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 |
# File 'lib/oci/identity/identity_client.rb', line 3919 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.
3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 |
# File 'lib/oci/identity/identity_client.rb', line 3972 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.
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 |
# File 'lib/oci/identity/identity_client.rb', line 4025 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.
4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 |
# File 'lib/oci/identity/identity_client.rb', line 4080 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.
4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 |
# File 'lib/oci/identity/identity_client.rb', line 4135 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.
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 |
# File 'lib/oci/identity/identity_client.rb', line 4192 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.
4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 |
# File 'lib/oci/identity/identity_client.rb', line 4247 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.
4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 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 |
# File 'lib/oci/identity/identity_client.rb', line 4306 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_bulk_action_resource_types(bulk_action_type, opts = {}) ⇒ Response
Lists the resource types supported by compartment bulk actions.
4365 4366 4367 4368 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 4403 4404 4405 |
# File 'lib/oci/identity/identity_client.rb', line 4365 def list_bulk_action_resource_types(bulk_action_type, opts = {}) logger.debug 'Calling operation IdentityClient#list_bulk_action_resource_types.' if logger raise "Missing the required parameter 'bulk_action_type' when calling list_bulk_action_resource_types." if bulk_action_type.nil? unless %w[BULK_MOVE_RESOURCES BULK_DELETE_RESOURCES].include?(bulk_action_type) raise "Invalid value for 'bulk_action_type', must be one of BULK_MOVE_RESOURCES, BULK_DELETE_RESOURCES." end path = '/compartments/bulkActionResourceTypes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:bulkActionType] = bulk_action_type 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_bulk_action_resource_types') 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::BulkActionResourceTypeCollection' ) 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).
4477 4478 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 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 |
# File 'lib/oci/identity/identity_client.rb', line 4477 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 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 if opts[:lifecycle_state] && !OCI::Identity::Models::Compartment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::Compartment::LIFECYCLE_STATE_ENUM.' 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? query_params[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_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).
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 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 |
# File 'lib/oci/identity/identity_client.rb', line 4559 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.
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 |
# File 'lib/oci/identity/identity_client.rb', line 4615 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).
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 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 |
# File 'lib/oci/identity/identity_client.rb', line 4693 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? 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 if opts[:lifecycle_state] && !OCI::Identity::Models::DynamicGroup::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::DynamicGroup::LIFECYCLE_STATE_ENUM.' end 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] query_params[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_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).
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 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 |
# File 'lib/oci/identity/identity_client.rb', line 4769 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).
4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 |
# File 'lib/oci/identity/identity_client.rb', line 4849 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? 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 if opts[:lifecycle_state] && !OCI::Identity::Models::Group::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::Group::LIFECYCLE_STATE_ENUM.' end 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] query_params[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_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.
4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 |
# File 'lib/oci/identity/identity_client.rb', line 4926 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? if opts[:lifecycle_state] && !OCI::Identity::Models::IdentityProvider::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::IdentityProvider::LIFECYCLE_STATE_ENUM.' end 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] query_params[:name] = opts[:name] if opts[:name] 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_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).
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 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 |
# File 'lib/oci/identity/identity_client.rb', line 5014 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? 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 if opts[:lifecycle_state] && !OCI::Identity::Models::IdentityProvider::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::IdentityProvider::LIFECYCLE_STATE_ENUM.' end 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] query_params[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_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.
5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 |
# File 'lib/oci/identity/identity_client.rb', line 5093 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.
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 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 |
# File 'lib/oci/identity/identity_client.rb', line 5166 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_network_sources(compartment_id, opts = {}) ⇒ Response
Lists the network sources in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See [Where to Get the Tenancy’s OCID and User’s OCID](docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
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 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 |
# File 'lib/oci/identity/identity_client.rb', line 5255 def list_network_sources(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_network_sources.' if logger raise "Missing the required parameter 'compartment_id' when calling list_network_sources." if compartment_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 if opts[:lifecycle_state] && !OCI::Identity::Models::NetworkSources::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::NetworkSources::LIFECYCLE_STATE_ENUM.' end path = '/networkSources' 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[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_network_sources') 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::NetworkSourcesSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_o_auth_client_credentials(user_id, opts = {}) ⇒ Response
List of Oauth tokens for the user
5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 |
# File 'lib/oci/identity/identity_client.rb', line 5331 def list_o_auth_client_credentials(user_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_o_auth_client_credentials.' if logger raise "Missing the required parameter 'user_id' when calling list_o_auth_client_credentials." if user_id.nil? if opts[:lifecycle_state] && !OCI::Identity::Models::OAuth2ClientCredentialSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::OAuth2ClientCredentialSummary::LIFECYCLE_STATE_ENUM.' end raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id) path = '/users/{userId}/oauth2ClientCredentials'.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[: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_o_auth_client_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::OAuth2ClientCredentialSummary>' ) 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.
5417 5418 5419 5420 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 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 |
# File 'lib/oci/identity/identity_client.rb', line 5417 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? 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 if opts[:lifecycle_state] && !OCI::Identity::Models::Policy::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::Policy::LIFECYCLE_STATE_ENUM.' end 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] query_params[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_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.
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 5517 5518 5519 5520 5521 5522 |
# File 'lib/oci/identity/identity_client.rb', line 5487 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.
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 |
# File 'lib/oci/identity/identity_client.rb', line 5539 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.
5592 5593 5594 5595 5596 5597 5598 5599 5600 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 |
# File 'lib/oci/identity/identity_client.rb', line 5592 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.
5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 |
# File 'lib/oci/identity/identity_client.rb', line 5649 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.
5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 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 |
# File 'lib/oci/identity/identity_client.rb', line 5713 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.
5783 5784 5785 5786 5787 5788 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 |
# File 'lib/oci/identity/identity_client.rb', line 5783 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_tagging_work_request_errors(work_request_id, opts = {}) ⇒ Response
Gets the errors for a work request.
5847 5848 5849 5850 5851 5852 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 |
# File 'lib/oci/identity/identity_client.rb', line 5847 def list_tagging_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_tagging_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_tagging_work_request_errors." 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 = '/taggingWorkRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_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_tagging_work_request_errors') 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::TaggingWorkRequestErrorSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_tagging_work_request_logs(work_request_id, opts = {}) ⇒ Response
Gets the logs for a work request.
5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 |
# File 'lib/oci/identity/identity_client.rb', line 5905 def list_tagging_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_tagging_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_tagging_work_request_logs." 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 = '/taggingWorkRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_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_tagging_work_request_logs') 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::TaggingWorkRequestLogSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_tagging_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the tagging work requests in compartment.
5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 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 |
# File 'lib/oci/identity/identity_client.rb', line 5965 def list_tagging_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#list_tagging_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_tagging_work_requests." if compartment_id.nil? path = '/taggingWorkRequests/' 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_tagging_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::TaggingWorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_tags(tag_namespace_id, opts = {}) ⇒ Response
Lists the tag definitions in the specified tag namespace.
6027 6028 6029 6030 6031 6032 6033 6034 6035 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 |
# File 'lib/oci/identity/identity_client.rb', line 6027 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 individually required, you must set one of them.
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 6133 6134 6135 6136 6137 6138 6139 6140 6141 |
# File 'lib/oci/identity/identity_client.rb', line 6102 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).
6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 |
# File 'lib/oci/identity/identity_client.rb', line 6187 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? 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 if opts[:lifecycle_state] && !OCI::Identity::Models::User::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Identity::Models::User::LIFECYCLE_STATE_ENUM.' end 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] query_params[:name] = opts[:name] if opts[:name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] 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_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.
6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 |
# File 'lib/oci/identity/identity_client.rb', line 6265 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.
101 102 103 |
# File 'lib/oci/identity/identity_client.rb', line 101 def logger @api_client.config.logger end |
#move_compartment(compartment_id, move_compartment_details, opts = {}) ⇒ Response
Move the compartment to a different parent compartment in the same tenancy. When you move a compartment, all its contents (subcompartments and resources) are moved with it. Note that the ‘CompartmentId` that you specify in the path is the compartment that you want to move.
IMPORTANT: After you move a compartment to a new parent compartment, the access policies of the new parent take effect and the policies of the previous parent no longer apply. Ensure that you are aware of the implications for the compartment contents before you move it. For more information, see [Moving a Compartment](docs.cloud.oracle.com/Content/Identity/Tasks/managingcompartments.htm#MoveCompartment).
6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 |
# File 'lib/oci/identity/identity_client.rb', line 6341 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 |
#recover_compartment(compartment_id, opts = {}) ⇒ Response
Recover the compartment from DELETED state to ACTIVE state.
6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 |
# File 'lib/oci/identity/identity_client.rb', line 6404 def recover_compartment(compartment_id, opts = {}) logger.debug 'Calling operation IdentityClient#recover_compartment.' if logger raise "Missing the required parameter 'compartment_id' when calling recover_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}/actions/recoverCompartment'.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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#recover_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 |
#remove_user_from_group(user_group_membership_id, opts = {}) ⇒ Response
Removes a user from a group by deleting the corresponding ‘UserGroupMembership`.
6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 |
# File 'lib/oci/identity/identity_client.rb', line 6461 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.
6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 |
# File 'lib/oci/identity/identity_client.rb', line 6514 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.
6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 |
# File 'lib/oci/identity/identity_client.rb', line 6573 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
6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 |
# File 'lib/oci/identity/identity_client.rb', line 6634 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.
6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 |
# File 'lib/oci/identity/identity_client.rb', line 6692 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.
6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 |
# File 'lib/oci/identity/identity_client.rb', line 6752 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.
6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 |
# File 'lib/oci/identity/identity_client.rb', line 6812 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.
6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 |
# File 'lib/oci/identity/identity_client.rb', line 6870 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.
6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 |
# File 'lib/oci/identity/identity_client.rb', line 6928 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.
6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 |
# File 'lib/oci/identity/identity_client.rb', line 6987 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_network_source(network_source_id, update_network_source_details, opts = {}) ⇒ Response
Updates the specified network source.
7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 |
# File 'lib/oci/identity/identity_client.rb', line 7047 def update_network_source(network_source_id, update_network_source_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_network_source.' if logger raise "Missing the required parameter 'network_source_id' when calling update_network_source." if network_source_id.nil? raise "Missing the required parameter 'update_network_source_details' when calling update_network_source." if update_network_source_details.nil? raise "Parameter value for 'network_source_id' must not be blank" if OCI::Internal::Util.blank_string?(network_source_id) path = '/networkSources/{networkSourceId}'.sub('{networkSourceId}', network_source_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_network_source_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_network_source') 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::NetworkSources' ) end # rubocop:enable Metrics/BlockLength end |
#update_o_auth_client_credential(user_id, oauth2_client_credential_id, update_o_auth2_client_credential_details, opts = {}) ⇒ Response
Updates Oauth token for the user
7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 |
# File 'lib/oci/identity/identity_client.rb', line 7107 def update_o_auth_client_credential(user_id, oauth2_client_credential_id, update_o_auth2_client_credential_details, opts = {}) logger.debug 'Calling operation IdentityClient#update_o_auth_client_credential.' if logger raise "Missing the required parameter 'user_id' when calling update_o_auth_client_credential." if user_id.nil? raise "Missing the required parameter 'oauth2_client_credential_id' when calling update_o_auth_client_credential." if oauth2_client_credential_id.nil? raise "Missing the required parameter 'update_o_auth2_client_credential_details' when calling update_o_auth_client_credential." if update_o_auth2_client_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 'oauth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(oauth2_client_credential_id) path = '/users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}'.sub('{userId}', user_id.to_s).sub('{oauth2ClientCredentialId}', oauth2_client_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_o_auth2_client_credential_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'IdentityClient#update_o_auth_client_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::OAuth2ClientCredential' ) 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.
7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 |
# File 'lib/oci/identity/identity_client.rb', line 7170 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.
7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 |
# File 'lib/oci/identity/identity_client.rb', line 7230 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.
7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 |
# File 'lib/oci/identity/identity_client.rb', line 7294 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 specified tag definition.
Setting ‘validator` determines the value type. Tags can use either a static value or a list of possible values. Static values are entered by a user applying the tag to a resource. Lists are created by you and the user must apply a value from the list. On update, any values in a list that were previously set do not change, but new values must pass validation. Values already applied to a resource do not change.
You cannot remove list values that appear in a TagDefault. To remove a list value that appears in a TagDefault, first update the TagDefault to use a different value.
7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 |
# File 'lib/oci/identity/identity_client.rb', line 7367 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. If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked.
-
If the ‘isRequired` flag is set to "true", the value is set during resource creation.
-
If the ‘isRequired` flag is set to "false", the value you enter is set during resource creation.
7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 |
# File 'lib/oci/identity/identity_client.rb', line 7436 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 individually 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.
7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 |
# File 'lib/oci/identity/identity_client.rb', line 7502 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.
7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 |
# File 'lib/oci/identity/identity_client.rb', line 7560 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.
7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 |
# File 'lib/oci/identity/identity_client.rb', line 7619 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.
7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 |
# File 'lib/oci/identity/identity_client.rb', line 7678 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.
7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 |
# File 'lib/oci/identity/identity_client.rb', line 7753 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 |