Class: OCI::IdentityDomains::IdentityDomainsClient

Inherits:

Object

• Object
• OCI::IdentityDomains::IdentityDomainsClient

Defined in:

lib/oci/identity_domains/identity_domains_client.rb

Overview

Use the Identity Domains API to manage resources within an identity domain, for example, users, dynamic resource groups, groups, and identity providers. For information about managing resources within identity domains, see Identity and Access Management (with identity domains). This REST API is SCIM compliant. Use the table of contents and search tool to explore the Identity Domains API.

Instance Attribute Summary

• #api_client ⇒ OCI::ApiClient readonly

  Client used to make HTTP requests.

• #endpoint ⇒ String readonly

  Fully qualified endpoint URL.

• #retry_config ⇒ OCI::Retry::RetryConfig readonly

  The default retry configuration to apply to all operations in this service client.

Instance Method Summary

• #create_api_key(opts = {}) ⇒ Response

  Create a user's API key.

• #create_app(opts = {}) ⇒ Response

  Create an App.

• #create_app_role(opts = {}) ⇒ Response

  Create an AppRole.

• #create_approval_workflow(opts = {}) ⇒ Response

  Create ApprovalWorkflow.

• #create_approval_workflow_assignment(opts = {}) ⇒ Response

  Create Approval Workflow Assignment.

• #create_approval_workflow_step(opts = {}) ⇒ Response

  Create ApprovalWorkflowStep.

• #create_auth_token(opts = {}) ⇒ Response

  Create a user's Auth token.

• #create_authentication_factors_remover(opts = {}) ⇒ Response

  Remove All Authentication Factor Channels for a User.

• #create_cloud_gate(opts = {}) ⇒ Response

  Create a Cloud Gate.

• #create_cloud_gate_mapping(opts = {}) ⇒ Response

  Create a Cloud Gate mapping.

• #create_cloud_gate_server(opts = {}) ⇒ Response

  Create a Cloud Gate server.

• #create_condition(opts = {}) ⇒ Response

  Create a Condition.

• #create_customer_secret_key(opts = {}) ⇒ Response

  Create a user's customer secret key.

• #create_dynamic_resource_group(opts = {}) ⇒ Response

  Create a Dynamic Resource Group.

• #create_grant(opts = {}) ⇒ Response

  Add a Grantee to an AppRole.

• #create_group(opts = {}) ⇒ Response

  Create a group.

• #create_identity_provider(opts = {}) ⇒ Response

  Create an Identity Provider.

• #create_me(opts = {}) ⇒ Response

  Self register a user.

• #create_my_api_key(opts = {}) ⇒ Response

  Add a user's own API key.

• #create_my_auth_token(opts = {}) ⇒ Response

  Create a user's own Auth token.

• #create_my_authentication_factor_initiator(opts = {}) ⇒ Response

  Initiate Self Service Enrollment using the Requested MFA Factor.

• #create_my_authentication_factor_validator(opts = {}) ⇒ Response

  Validate Self Service Enrollment using the Requested MFA Factor.

• #create_my_authentication_factors_remover(opts = {}) ⇒ Response

  Remove All Authentication Factor Channels for a User.

• #create_my_customer_secret_key(opts = {}) ⇒ Response

  Add a user's own customer secret key.

• #create_my_o_auth2_client_credential(opts = {}) ⇒ Response

  Create a user's own OAuth2 client credential.

• #create_my_request(opts = {}) ⇒ Response

  Create a Request.

• #create_my_smtp_credential(opts = {}) ⇒ Response

  Create a user's own SMTP credential.

• #create_my_support_account(opts = {}) ⇒ Response

  Create a user's own support account.

• #create_my_user_db_credential(opts = {}) ⇒ Response

  Create a user's own database (DB) credential.

• #create_network_perimeter(opts = {}) ⇒ Response

  Create a NetworkPerimeter.

• #create_o_auth2_client_credential(opts = {}) ⇒ Response

  Add a user's OAuth2 client credentials.

• #create_o_auth_client_certificate(opts = {}) ⇒ Response

  Create an OAuth Client Certificate.

• #create_o_auth_partner_certificate(opts = {}) ⇒ Response

  Create an OAuth Partner Certificate.

• #create_password_policy(opts = {}) ⇒ Response

  Create a password policy.

• #create_policy(opts = {}) ⇒ Response

  Create a Policy.

• #create_rule(opts = {}) ⇒ Response

  Create a Rule.

• #create_security_question(opts = {}) ⇒ Response

  Create a security question.

• #create_self_registration_profile(opts = {}) ⇒ Response

  Create a self-registration profile.

• #create_smtp_credential(opts = {}) ⇒ Response

  Create a user's SMTP credentials.

• #create_user(opts = {}) ⇒ Response

  Create a user.

• #create_user_db_credential(opts = {}) ⇒ Response

  Create a user's database (DB) credentials.

• #delete_api_key(api_key_id, opts = {}) ⇒ Response

  Delete a user's API key.

• #delete_app(app_id, opts = {}) ⇒ Response

  Delete an App.

• #delete_app_role(app_role_id, opts = {}) ⇒ Response

  Delete an AppRole.

• #delete_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

  Delete ApprovalWorkflow.

• #delete_approval_workflow_assignment(approval_workflow_assignment_id, opts = {}) ⇒ Response

  Delete Approval Workflow Assignment.

• #delete_approval_workflow_step(approval_workflow_step_id, opts = {}) ⇒ Response

  Delete ApprovalWorkflowStep.

• #delete_auth_token(auth_token_id, opts = {}) ⇒ Response

  Delete a user's Auth token.

• #delete_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

  Delete a Cloud Gate.

• #delete_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

  Delete a Cloud Gate mapping.

• #delete_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

  Delete a Cloud Gate server.

• #delete_condition(condition_id, opts = {}) ⇒ Response

  Delete a Condition.

• #delete_customer_secret_key(customer_secret_key_id, opts = {}) ⇒ Response

  Delete a user's customer secret key.

• #delete_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

  Delete a Dynamic Resource Group.

• #delete_grant(grant_id, opts = {}) ⇒ Response

  Remove a Grantee from an AppRole.

• #delete_group(group_id, opts = {}) ⇒ Response

  Delete a group.

• #delete_identity_provider(identity_provider_id, opts = {}) ⇒ Response

  Delete an Identity Provider.

• #delete_my_api_key(my_api_key_id, opts = {}) ⇒ Response

  Delete a user's own API key.

• #delete_my_auth_token(my_auth_token_id, opts = {}) ⇒ Response

  Delete a user's own Auth token.

• #delete_my_customer_secret_key(my_customer_secret_key_id, opts = {}) ⇒ Response

  Delete a user's own customer secret key.

• #delete_my_device(my_device_id, opts = {}) ⇒ Response

  Delete a Device.

• #delete_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {}) ⇒ Response

  Delete a user's own OAuth2 client credential.

• #delete_my_smtp_credential(my_smtp_credential_id, opts = {}) ⇒ Response

  Delete a user's own SMTP credential.

• #delete_my_support_account(my_support_account_id, opts = {}) ⇒ Response

  Delete a user's own support account.

• #delete_my_trusted_user_agent(my_trusted_user_agent_id, opts = {}) ⇒ Response

  Delete a Trusted User Agent.

• #delete_my_user_db_credential(my_user_db_credential_id, opts = {}) ⇒ Response

  Delete a user's own database (DB) credential.

• #delete_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

  Delete a NetworkPerimeter.

• #delete_o_auth2_client_credential(o_auth2_client_credential_id, opts = {}) ⇒ Response

  Delete a user's OAuth2 client credentials.

• #delete_o_auth_client_certificate(o_auth_client_certificate_id, opts = {}) ⇒ Response

  Delete an OAuth Client Certificate.

• #delete_o_auth_partner_certificate(o_auth_partner_certificate_id, opts = {}) ⇒ Response

  Delete an OAuth Partner Certificate.

• #delete_password_policy(password_policy_id, opts = {}) ⇒ Response

  Delete a password policy.

• #delete_policy(policy_id, opts = {}) ⇒ Response

  Delete a Policy.

• #delete_rule(rule_id, opts = {}) ⇒ Response

  Delete a Rule.

• #delete_security_question(security_question_id, opts = {}) ⇒ Response

  Delete a security question.

• #delete_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

  Delete a self-registration profile.

• #delete_smtp_credential(smtp_credential_id, opts = {}) ⇒ Response

  Delete a user's SMTP credentials.

• #delete_user(user_id, opts = {}) ⇒ Response

  Delete a user.

• #delete_user_db_credential(user_db_credential_id, opts = {}) ⇒ Response

  Delete a user's database (DB) credentials.

• #get_account_mgmt_info(account_mgmt_info_id, opts = {}) ⇒ Response

  Get Account Mgmt Info.

• #get_account_recovery_setting(account_recovery_setting_id, opts = {}) ⇒ Response

  Get an account recovery setting.

• #get_api_key(api_key_id, opts = {}) ⇒ Response

  Get a user's API key.

• #get_app(app_id, opts = {}) ⇒ Response

  Get an App.

• #get_app_role(app_role_id, opts = {}) ⇒ Response

  Get an AppRole.

• #get_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

  Get ApprovalWorkflow.

• #get_approval_workflow_assignment(approval_workflow_assignment_id, opts = {}) ⇒ Response

  Get an Approval Workflow Assignment.

• #get_approval_workflow_step(approval_workflow_step_id, opts = {}) ⇒ Response

  Get ApprovalWorkflowStep.

• #get_auth_token(auth_token_id, opts = {}) ⇒ Response

  Get a user's Auth token.

• #get_authentication_factor_setting(authentication_factor_setting_id, opts = {}) ⇒ Response

  Get Authentication Factor Settings.

• #get_branding_setting(branding_setting_id, opts = {}) ⇒ Response

  Get Branding Settings.

• #get_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

  Get a Cloud Gate.

• #get_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

  Get a Cloud Gate mapping.

• #get_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

  Get a Cloud Gate server.

• #get_condition(condition_id, opts = {}) ⇒ Response

  Get a Condition.

• #get_customer_secret_key(customer_secret_key_id, opts = {}) ⇒ Response

  Get a user's customer secret key.

• #get_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

  Get a Dynamic Resource Group.

• #get_grant(grant_id, opts = {}) ⇒ Response

  Get a Grant.

• #get_group(group_id, opts = {}) ⇒ Response

  Get a group.

• #get_identity_provider(identity_provider_id, opts = {}) ⇒ Response

  Get an Identity Provider.

• #get_identity_setting(identity_setting_id, opts = {}) ⇒ Response

  Get an Identity setting.

• #get_kmsi_setting(kmsi_setting_id, opts = {}) ⇒ Response

  Get KmsiSettings.

• #get_me(opts = {}) ⇒ Response

  Get a user's own information.

• #get_my_api_key(my_api_key_id, opts = {}) ⇒ Response

  Get a user's own API key.

• #get_my_auth_token(my_auth_token_id, opts = {}) ⇒ Response

  Get a user's own Auth token.

• #get_my_completed_approval(my_completed_approval_id, opts = {}) ⇒ Response

  Get My MyCompletedApproval.

• #get_my_customer_secret_key(my_customer_secret_key_id, opts = {}) ⇒ Response

  Get a user's own customer secret key.

• #get_my_device(my_device_id, opts = {}) ⇒ Response

  Get a Device.

• #get_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {}) ⇒ Response

  Get a user's own OAuth2 client credential.

• #get_my_pending_approval(my_pending_approval_id, opts = {}) ⇒ Response

  Get My MyPendingApproval.

• #get_my_request(my_request_id, opts = {}) ⇒ Response

  Get My Requests.

• #get_my_smtp_credential(my_smtp_credential_id, opts = {}) ⇒ Response

  Get a user's own SMTP credential.

• #get_my_support_account(my_support_account_id, opts = {}) ⇒ Response

  Get a user's own support account.

• #get_my_trusted_user_agent(my_trusted_user_agent_id, opts = {}) ⇒ Response

  Get a Trusted User Agent.

• #get_my_user_db_credential(my_user_db_credential_id, opts = {}) ⇒ Response

  Get a user's own database (DB) credential.

• #get_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

  Get a NetworkPerimeter.

• #get_notification_setting(notification_setting_id, opts = {}) ⇒ Response

  Get Notification Settings.

• #get_o_auth2_client_credential(o_auth2_client_credential_id, opts = {}) ⇒ Response

  Get a user's OAuth2 client credentials.

• #get_o_auth_client_certificate(o_auth_client_certificate_id, opts = {}) ⇒ Response

  Get OAuth Client Certificates.

• #get_o_auth_partner_certificate(o_auth_partner_certificate_id, opts = {}) ⇒ Response

  Get an OAuth Partner Certificate.

• #get_password_policy(password_policy_id, opts = {}) ⇒ Response

  Get a password policy.

• #get_policy(policy_id, opts = {}) ⇒ Response

  Get a Policy.

• #get_rule(rule_id, opts = {}) ⇒ Response

  Get a Rule.

• #get_schema(schema_id, opts = {}) ⇒ Response

  Get a Schema.

• #get_security_question(security_question_id, opts = {}) ⇒ Response

  Get a security question.

• #get_security_question_setting(security_question_setting_id, opts = {}) ⇒ Response

  Get a security question setting.

• #get_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

  Get a self-registration profile.

• #get_setting(setting_id, opts = {}) ⇒ Response

  Get Settings.

• #get_smtp_credential(smtp_credential_id, opts = {}) ⇒ Response

  Get a user's SMTP credentials.

• #get_user(user_id, opts = {}) ⇒ Response

  Get a user.

• #get_user_attributes_setting(user_attributes_setting_id, opts = {}) ⇒ Response

  Get User Schema Attribute Settings.

• #get_user_db_credential(user_db_credential_id, opts = {}) ⇒ Response

  Get a user's database (DB) credentials.

• #initialize(config: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ IdentityDomainsClient constructor

  Creates a new IdentityDomainsClient.

• #list_account_mgmt_infos(opts = {}) ⇒ Response

  Search Account Mgmt Info.

• #list_account_recovery_settings(opts = {}) ⇒ Response

  Search for account recovery settings.

• #list_api_keys(opts = {}) ⇒ Response

  Search API keys.

• #list_app_roles(opts = {}) ⇒ Response

  Search AppRoles.

• #list_approval_workflow_assignments(opts = {}) ⇒ Response

  Search Approval Workflow Assignments.

• #list_approval_workflow_steps(opts = {}) ⇒ Response

  Search ApprovalWorkflowStep.

• #list_approval_workflows(opts = {}) ⇒ Response

  Search ApprovalWorkflow.

• #list_apps(opts = {}) ⇒ Response

  Search Apps.

• #list_auth_tokens(opts = {}) ⇒ Response

  Search for Auth tokens.

• #list_authentication_factor_settings(opts = {}) ⇒ Response

  Search Authentication Factor Settings.

• #list_branding_settings(opts = {}) ⇒ Response

  Search Branding Settings.

• #list_cloud_gate_mappings(opts = {}) ⇒ Response

  Search Cloud Gate mappings.

• #list_cloud_gate_servers(opts = {}) ⇒ Response

  Search Cloud Gate servers.

• #list_cloud_gates(opts = {}) ⇒ Response

  Search Cloud Gates.

• #list_conditions(opts = {}) ⇒ Response

  Search Conditions.

• #list_customer_secret_keys(opts = {}) ⇒ Response

  Search for a user's customer secret keys.

• #list_dynamic_resource_groups(opts = {}) ⇒ Response

  Search for Dynamic Resource Groups.

• #list_grants(opts = {}) ⇒ Response

  Search Grants.

• #list_groups(opts = {}) ⇒ Response

  Search for groups.

• #list_identity_providers(opts = {}) ⇒ Response

  Search Identity Providers.

• #list_identity_settings(opts = {}) ⇒ Response

  Search for Identity settings.

• #list_kmsi_settings(opts = {}) ⇒ Response

  Search KmsiSettings.

• #list_my_api_keys(opts = {}) ⇒ Response

  Search for a user's own API key.

• #list_my_apps(opts = {}) ⇒ Response

  Search My Apps.

• #list_my_auth_tokens(opts = {}) ⇒ Response

  Search for a user's own Auth token.

• #list_my_completed_approvals(opts = {}) ⇒ Response

  Search My MyCompletedApproval.

• #list_my_customer_secret_keys(opts = {}) ⇒ Response

  Search for a user's own customer secret key.

• #list_my_devices(opts = {}) ⇒ Response

  Search Devices.

• #list_my_groups(opts = {}) ⇒ Response

  Search for 'My Groups'.

• #list_my_o_auth2_client_credentials(opts = {}) ⇒ Response

  Search for a user's own OAuth2 client credential.

• #list_my_pending_approvals(opts = {}) ⇒ Response

  Search My Approvals.

• #list_my_requestable_groups(opts = {}) ⇒ Response

  Search My Requestable Groups.

• #list_my_requests(opts = {}) ⇒ Response

  Search My Requests.

• #list_my_smtp_credentials(opts = {}) ⇒ Response

  Search for a user's own SMTP credential.

• #list_my_support_accounts(opts = {}) ⇒ Response

  Search for a user's own support account.

• #list_my_trusted_user_agents(opts = {}) ⇒ Response

  Search Trusted User Agents.

• #list_my_user_db_credentials(opts = {}) ⇒ Response

  Search for a user's own database (DB) credential.

• #list_network_perimeters(opts = {}) ⇒ Response

  Search NetworkPerimeters.

• #list_notification_settings(opts = {}) ⇒ Response

  Search Notification Settings.

• #list_o_auth2_client_credentials(opts = {}) ⇒ Response

  Search for a user's OAuth2 client credentials.

• #list_o_auth_client_certificates(opts = {}) ⇒ Response

  Search OAuth Client Certificates.

• #list_o_auth_partner_certificates(opts = {}) ⇒ Response

  Search OAuth Partner Certificates.

• #list_password_policies(opts = {}) ⇒ Response

  Search for password policies.

• #list_policies(opts = {}) ⇒ Response

  Search Policies.

• #list_resource_type_schema_attributes(opts = {}) ⇒ Response

  Search Resource Type Schema Attributes.

• #list_rules(opts = {}) ⇒ Response

  Search Rules.

• #list_schemas(opts = {}) ⇒ Response

  Search Schemas.

• #list_security_question_settings(opts = {}) ⇒ Response

  Search for security question settings.

• #list_security_questions(opts = {}) ⇒ Response

  Search for security questions.

• #list_self_registration_profiles(opts = {}) ⇒ Response

  Search for self-registration profiles.

• #list_settings(opts = {}) ⇒ Response

  Search Settings.

• #list_smtp_credentials(opts = {}) ⇒ Response

  Search for SMTP credentials.

• #list_user_attributes_settings(opts = {}) ⇒ Response

  Search User Schema Attribute Settings.

• #list_user_db_credentials(opts = {}) ⇒ Response

  Search for a user's database (DB) credentials.

• #list_users(opts = {}) ⇒ Response

  Search for users.

• #logger ⇒ Logger

  The logger for this client.

• #patch_account_recovery_setting(account_recovery_setting_id, opts = {}) ⇒ Response

  Update an account recovery setting.

• #patch_api_key(api_key_id, opts = {}) ⇒ Response

  Update a user's API key.

• #patch_app(app_id, opts = {}) ⇒ Response

  Update an App.

• #patch_app_role(app_role_id, opts = {}) ⇒ Response

  Update an AppRole.

• #patch_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

  Update ApprovalWorkflow.

• #patch_approval_workflow_step(approval_workflow_step_id, opts = {}) ⇒ Response

  Update ApprovalWorkflowStep.

• #patch_auth_token(auth_token_id, opts = {}) ⇒ Response

  Update a user's Auth token.

• #patch_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

  Update a Cloud Gate.

• #patch_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

  Update a Cloud Gate mapping.

• #patch_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

  Update a Cloud Gate server.

• #patch_condition(condition_id, opts = {}) ⇒ Response

  Update a Condition.

• #patch_customer_secret_key(customer_secret_key_id, opts = {}) ⇒ Response

  Update a user's customer secret key.

• #patch_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

  Update a Dynamic Resource Group.

• #patch_grant(grant_id, opts = {}) ⇒ Response

  Update a Grant.

• #patch_group(group_id, opts = {}) ⇒ Response

  Update a group.

• #patch_identity_provider(identity_provider_id, opts = {}) ⇒ Response

  Update an Identity Provider.

• #patch_identity_setting(identity_setting_id, opts = {}) ⇒ Response

  Update an Identity setting.

• #patch_kmsi_setting(kmsi_setting_id, opts = {}) ⇒ Response

  Update a Setting.

• #patch_me(opts = {}) ⇒ Response

  Update a user's own information.

• #patch_my_api_key(my_api_key_id, opts = {}) ⇒ Response

  Update a user's own API key.

• #patch_my_auth_token(my_auth_token_id, opts = {}) ⇒ Response

  Update a user's own Auth token.

• #patch_my_customer_secret_key(my_customer_secret_key_id, opts = {}) ⇒ Response

  Update a user's own customer secret key.

• #patch_my_device(my_device_id, opts = {}) ⇒ Response

  Update a Device.

• #patch_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {}) ⇒ Response

  Update a user's own OAuth2 client credential.

• #patch_my_pending_approval(my_pending_approval_id, opts = {}) ⇒ Response

  Update MyPendingApproval.

• #patch_my_request(my_request_id, opts = {}) ⇒ Response

  Update My Requests.

• #patch_my_smtp_credential(my_smtp_credential_id, opts = {}) ⇒ Response

  Update a user's own SMTP credential.

• #patch_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

  Update a NetworkPerimeter.

• #patch_o_auth2_client_credential(o_auth2_client_credential_id, opts = {}) ⇒ Response

  Update a user's OAuth2 client credentials.

• #patch_password_policy(password_policy_id, opts = {}) ⇒ Response

  Update a password policy.

• #patch_policy(policy_id, opts = {}) ⇒ Response

  Update a Policy.

• #patch_rule(rule_id, opts = {}) ⇒ Response

  Update a Rule.

• #patch_schema(schema_id, opts = {}) ⇒ Response

  Update a Schema Def.

• #patch_security_question(security_question_id, opts = {}) ⇒ Response

  Update a security question.

• #patch_security_question_setting(security_question_setting_id, opts = {}) ⇒ Response

  Update a security question setting.

• #patch_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

  Update a self-registration profile.

• #patch_setting(setting_id, opts = {}) ⇒ Response

  Update a Setting.

• #patch_smtp_credential(smtp_credential_id, opts = {}) ⇒ Response

  Update a user's SMTP credentials.

• #patch_user(user_id, opts = {}) ⇒ Response

  Update a user.

• #patch_user_attributes_setting(user_attributes_setting_id, opts = {}) ⇒ Response

  Update User Schema Attribute Settings.

• #put_account_recovery_setting(account_recovery_setting_id, opts = {}) ⇒ Response

  Replace an account recovery setting.

• #put_app(app_id, opts = {}) ⇒ Response

  Replace an App.

• #put_app_status_changer(app_status_changer_id, opts = {}) ⇒ Response

  Activate/Deactivate an App.

• #put_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

  Replace ApprovalWorkflow.

• #put_authentication_factor_setting(authentication_factor_setting_id, opts = {}) ⇒ Response

  Replace Authentication Factor Settings.

• #put_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

  Replace a Cloud Gate.

• #put_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

  Replace a Cloud Gate mapping.

• #put_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

  Replace a Cloud Gate server.

• #put_condition(condition_id, opts = {}) ⇒ Response

  Replace a Condition.

• #put_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

  Replace a Dynamic Resource Group.

• #put_group(group_id, opts = {}) ⇒ Response

  Replace a group.

• #put_identity_provider(identity_provider_id, opts = {}) ⇒ Response

  Replace an Identity Provider.

• #put_identity_setting(identity_setting_id, opts = {}) ⇒ Response

  Replace an Identity setting.

• #put_kmsi_setting(kmsi_setting_id, opts = {}) ⇒ Response

  Replace KmsiSettings.

• #put_me(opts = {}) ⇒ Response

  Replace a user's own information.

• #put_me_password_changer(opts = {}) ⇒ Response

  Update a user's own password.

• #put_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

  Replace a NetworkPerimeter.

• #put_notification_setting(notification_setting_id, opts = {}) ⇒ Response

  Replace Notification Settings.

• #put_password_policy(password_policy_id, opts = {}) ⇒ Response

  Replace a password policy.

• #put_policy(policy_id, opts = {}) ⇒ Response

  Replace a Policy.

• #put_rule(rule_id, opts = {}) ⇒ Response

  Replace a Rule.

• #put_schema(schema_id, opts = {}) ⇒ Response

  Replace a Schema Def.

• #put_security_question_setting(security_question_setting_id, opts = {}) ⇒ Response

  Replace a security question setting.

• #put_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

  Replace a self-registration profile.

• #put_setting(setting_id, opts = {}) ⇒ Response

  Replace Settings.

• #put_user(user_id, opts = {}) ⇒ Response

  Replace a user.

• #put_user_capabilities_changer(user_capabilities_changer_id, opts = {}) ⇒ Response

  Change a user's capabilities.

• #put_user_password_changer(user_password_changer_id, opts = {}) ⇒ Response

  Change a user's password to a known value.

• #put_user_password_resetter(user_password_resetter_id, opts = {}) ⇒ Response

  Reset a user's password to a randomly-generated value.

• #put_user_status_changer(user_status_changer_id, opts = {}) ⇒ Response

  Change a user's status.

• #search_account_mgmt_infos(opts = {}) ⇒ Response

  Search Account Mgmt Info Using POST.

• #search_api_keys(opts = {}) ⇒ Response

  Search for API keys using POST.

• #search_app_roles(opts = {}) ⇒ Response

  Search AppRoles Using POST.

• #search_apps(opts = {}) ⇒ Response

  Search Apps Using POST.

• #search_auth_tokens(opts = {}) ⇒ Response

  Search for Auth tokens using POST.

• #search_authentication_factor_settings(opts = {}) ⇒ Response

  Search Authentication Factor Settings Using POST.

• #search_cloud_gate_mappings(opts = {}) ⇒ Response

  Search Cloud Gate mappings Using POST.

• #search_cloud_gate_servers(opts = {}) ⇒ Response

  Search Cloud Gate servers Using POST.

• #search_cloud_gates(opts = {}) ⇒ Response

  Search Cloud Gates Using POST.

• #search_conditions(opts = {}) ⇒ Response

  Search Conditions Using POST.

• #search_customer_secret_keys(opts = {}) ⇒ Response

  Search for customer secret keys using POST.

• #search_dynamic_resource_groups(opts = {}) ⇒ Response

  Search for Dynamic Resource Groups using POST.

• #search_grants(opts = {}) ⇒ Response

  Search Grants Using POST.

• #search_groups(opts = {}) ⇒ Response

  Search for groups using POST.

• #search_identity_providers(opts = {}) ⇒ Response

  Search Identity Providers Using POST.

• #search_identity_settings(opts = {}) ⇒ Response

  Search for Identity settings using POST.

• #search_kmsi_settings(opts = {}) ⇒ Response

  Search KmsiSettings Using POST.

• #search_my_apps(opts = {}) ⇒ Response

  Search My Apps Using POST.

• #search_my_groups(opts = {}) ⇒ Response

  Search for 'My Groups' using POST.

• #search_my_requestable_groups(opts = {}) ⇒ Response

  Search My Requestable Groups Using POST.

• #search_my_requests(opts = {}) ⇒ Response

  Search My Requests Using POST.

• #search_network_perimeters(opts = {}) ⇒ Response

  Search NetworkPerimeters Using POST.

• #search_notification_settings(opts = {}) ⇒ Response

  Search Notification Settings Using POST.

• #search_o_auth2_client_credentials(opts = {}) ⇒ Response

  Search for OAuth2 client credentials using POST.

• #search_o_auth_client_certificates(opts = {}) ⇒ Response

  Search OAuth Client Certificates Using POST.

• #search_o_auth_partner_certificates(opts = {}) ⇒ Response

  Search OAuth Partner Certificates Using POST.

• #search_password_policies(opts = {}) ⇒ Response

  Search for password policies using POST.

• #search_policies(opts = {}) ⇒ Response

  Search Policies Using POST.

• #search_resource_type_schema_attributes(opts = {}) ⇒ Response

  Search Resource Type Schema Attributes Using POST.

• #search_rules(opts = {}) ⇒ Response

  Search Rules Using POST.

• #search_schemas(opts = {}) ⇒ Response

  Search Schemas Using POST.

• #search_security_question_settings(opts = {}) ⇒ Response

  Search for security question settings using POST.

• #search_security_questions(opts = {}) ⇒ Response

  Search for security questions using POST.

• #search_self_registration_profiles(opts = {}) ⇒ Response

  Search for self-registration profile using POST.

• #search_settings(opts = {}) ⇒ Response

  Search Settings Using POST.

• #search_smtp_credentials(opts = {}) ⇒ Response

  Search for SMTP credentials using POST.

• #search_user_attributes_settings(opts = {}) ⇒ Response

  Search User Schema Attribute Settings Using POST.

• #search_user_db_credentials(opts = {}) ⇒ Response

  Search for a user's database (DB) credentials using POST.

• #search_users(opts = {}) ⇒ Response

  Search for users using POST.

Constructor Details

#initialize(config: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ IdentityDomainsClient

Creates a new IdentityDomainsClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Parameters:

• config (Config) (defaults to: nil) —

  A Config object.

• endpoint (String) (defaults to: nil) —

  The fully qualified endpoint URL

• signer (OCI::BaseSigner) (defaults to: nil) —

  A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

• proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

  If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

• retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

  The retry configuration for this service client. This represents the default retry configuration to apply across all operations. 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

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 46

def initialize(config: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  raise 'A fully qualified endpoint URL must be defined' unless endpoint

  @endpoint = endpoint + ''

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

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config
  logger.info "IdentityDomainsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:

• (OCI::ApiClient)

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

• (String)

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20

def endpoint
  @endpoint
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

Returns:

• (OCI::Retry::RetryConfig)

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#create_api_key(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_api_key API.

Create a user's API key.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :api_key (OCI::IdentityDomains::Models::ApiKey) —

  ApiKey schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApiKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 104

def create_api_key(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_api_key.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApiKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:api_key])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_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::IdentityDomains::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_app(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_app API.

Create an App

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :app (OCI::IdentityDomains::Models::App) —

  App schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type App

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 189

def create_app(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_app.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Apps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:app])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_app') 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::IdentityDomains::Models::App'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_app_role(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_app_role API.

Create an AppRole

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :app_role (OCI::IdentityDomains::Models::AppRole) —

  AppRole schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AppRole

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 274

def create_app_role(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_app_role.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AppRoles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:app_role])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_app_role') 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::IdentityDomains::Models::AppRole'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_approval_workflow(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_approval_workflow API.

Create ApprovalWorkflow

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :approval_workflow (OCI::IdentityDomains::Models::ApprovalWorkflow) —

  ApprovalWorkflow schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflow

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 359

def create_approval_workflow(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_approval_workflow.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApprovalWorkflows'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:approval_workflow])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_approval_workflow') 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::IdentityDomains::Models::ApprovalWorkflow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_approval_workflow_assignment(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_approval_workflow_assignment API.

Create Approval Workflow Assignment

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :approval_workflow_assignment (OCI::IdentityDomains::Models::ApprovalWorkflowAssignment) —

  ApprovalWorkflowAssignment schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowAssignment

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 444

def create_approval_workflow_assignment(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_approval_workflow_assignment.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApprovalWorkflowAssignments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:approval_workflow_assignment])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_approval_workflow_assignment') 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::IdentityDomains::Models::ApprovalWorkflowAssignment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_approval_workflow_step(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_approval_workflow_step API.

Create ApprovalWorkflowStep

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :approval_workflow_step (OCI::IdentityDomains::Models::ApprovalWorkflowStep) —

  ApprovalWorkflowStep schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowStep

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 529

def create_approval_workflow_step(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_approval_workflow_step.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApprovalWorkflowSteps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:approval_workflow_step])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_approval_workflow_step') 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::IdentityDomains::Models::ApprovalWorkflowStep'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_auth_token(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_auth_token API.

Create a user's Auth token.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :auth_token (OCI::IdentityDomains::Models::AuthToken) —

  AuthToken schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AuthToken

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 614

def create_auth_token(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_auth_token.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AuthTokens'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:auth_token])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::AuthToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_authentication_factors_remover(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_authentication_factors_remover API.

Remove All Authentication Factor Channels for a User

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :authentication_factors_remover (OCI::IdentityDomains::Models::AuthenticationFactorsRemover) —

  AuthenticationFactorsRemover schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AuthenticationFactorsRemover

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 696

def create_authentication_factors_remover(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_authentication_factors_remover.' if logger


  path = '/admin/v1/AuthenticationFactorsRemover'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:authentication_factors_remover])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_authentication_factors_remover') 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::IdentityDomains::Models::AuthenticationFactorsRemover'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cloud_gate(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_cloud_gate API.

Create a Cloud Gate

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :cloud_gate (OCI::IdentityDomains::Models::CloudGate) —

  CloudGate schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 769

def create_cloud_gate(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_cloud_gate.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CloudGates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_cloud_gate') 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::IdentityDomains::Models::CloudGate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cloud_gate_mapping(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_cloud_gate_mapping API.

Create a Cloud Gate mapping

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :cloud_gate_mapping (OCI::IdentityDomains::Models::CloudGateMapping) —

  CloudGateMapping schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateMapping

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 854

def create_cloud_gate_mapping(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_cloud_gate_mapping.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CloudGateMappings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_mapping])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_cloud_gate_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::IdentityDomains::Models::CloudGateMapping'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cloud_gate_server(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_cloud_gate_server API.

Create a Cloud Gate server

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :cloud_gate_server (OCI::IdentityDomains::Models::CloudGateServer) —

  CloudGateServer schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateServer

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 939

def create_cloud_gate_server(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_cloud_gate_server.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CloudGateServers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_server])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_cloud_gate_server') 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::IdentityDomains::Models::CloudGateServer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_condition(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_condition API.

Create a Condition

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :condition (OCI::IdentityDomains::Models::Condition) —

  Condition schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Condition

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1024

def create_condition(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_condition.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Conditions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:condition])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_condition') 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::IdentityDomains::Models::Condition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_customer_secret_key(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_customer_secret_key API.

Create a user's customer secret key.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :customer_secret_key (OCI::IdentityDomains::Models::CustomerSecretKey) —

  CustomerSecretKey schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CustomerSecretKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1109

def create_customer_secret_key(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_customer_secret_key.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CustomerSecretKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:customer_secret_key])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::CustomerSecretKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_dynamic_resource_group(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_dynamic_resource_group API.

Create a Dynamic Resource Group.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :dynamic_resource_group (OCI::IdentityDomains::Models::DynamicResourceGroup) —

  DynamicResourceGroup schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type DynamicResourceGroup

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1194

def create_dynamic_resource_group(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_dynamic_resource_group.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/DynamicResourceGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:dynamic_resource_group])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_dynamic_resource_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::IdentityDomains::Models::DynamicResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_grant(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_grant API.

Add a Grantee to an AppRole

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :grant (OCI::IdentityDomains::Models::Grant) —

  Grant schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Grant

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1279

def create_grant(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_grant.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Grants'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:grant])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_grant') 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::IdentityDomains::Models::Grant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_group(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_group API.

Create a group.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :group (OCI::IdentityDomains::Models::Group) —

  Group schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Group

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1364

def create_group(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_group.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Groups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:group])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::Group'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_identity_provider(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_identity_provider API.

Create an Identity Provider

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :identity_provider (OCI::IdentityDomains::Models::IdentityProvider) —

  IdentityProvider schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentityProvider

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1449

def create_identity_provider(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_identity_provider.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/IdentityProviders'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:identity_provider])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::IdentityProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_me(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_me API.

Self register a user.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :me (OCI::IdentityDomains::Models::Me) —

  Me schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Me

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1534

def create_me(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_me.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Me'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:me])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_me') 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::IdentityDomains::Models::Me'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_api_key(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_api_key API.

Add a user's own API key.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_api_key (OCI::IdentityDomains::Models::MyApiKey) —

  MyApiKey schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyApiKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1616

def create_my_api_key(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_api_key.' if logger


  path = '/admin/v1/MyApiKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_api_key])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_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::IdentityDomains::Models::MyApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_auth_token(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_auth_token API.

Create a user's own Auth token.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_auth_token (OCI::IdentityDomains::Models::MyAuthToken) —

  MyAuthToken schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyAuthToken

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1686

def create_my_auth_token(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_auth_token.' if logger


  path = '/admin/v1/MyAuthTokens'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_auth_token])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_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::IdentityDomains::Models::MyAuthToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_authentication_factor_initiator(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_authentication_factor_initiator API.

Initiate Self Service Enrollment using the Requested MFA Factor

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_authentication_factor_initiator (OCI::IdentityDomains::Models::MyAuthenticationFactorInitiator) —

  MyAuthenticationFactorInitiator schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyAuthenticationFactorInitiator

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1756

def create_my_authentication_factor_initiator(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_authentication_factor_initiator.' if logger


  path = '/admin/v1/MyAuthenticationFactorInitiator'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_authentication_factor_initiator])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_authentication_factor_initiator') 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::IdentityDomains::Models::MyAuthenticationFactorInitiator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_authentication_factor_validator(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_authentication_factor_validator API.

Validate Self Service Enrollment using the Requested MFA Factor

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_authentication_factor_validator (OCI::IdentityDomains::Models::MyAuthenticationFactorValidator) —

  MyAuthenticationFactorValidator schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyAuthenticationFactorValidator

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1826

def create_my_authentication_factor_validator(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_authentication_factor_validator.' if logger


  path = '/admin/v1/MyAuthenticationFactorValidator'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_authentication_factor_validator])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_authentication_factor_validator') 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::IdentityDomains::Models::MyAuthenticationFactorValidator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_authentication_factors_remover(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_authentication_factors_remover API.

Remove All Authentication Factor Channels for a User

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_authentication_factors_remover (OCI::IdentityDomains::Models::MyAuthenticationFactorsRemover) —

  MyAuthenticationFactorsRemover schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyAuthenticationFactorsRemover

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1896

def create_my_authentication_factors_remover(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_authentication_factors_remover.' if logger


  path = '/admin/v1/MyAuthenticationFactorsRemover'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_authentication_factors_remover])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_authentication_factors_remover') 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::IdentityDomains::Models::MyAuthenticationFactorsRemover'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_customer_secret_key(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_customer_secret_key API.

Add a user's own customer secret key.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_customer_secret_key (OCI::IdentityDomains::Models::MyCustomerSecretKey) —

  MyCustomerSecretKey schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyCustomerSecretKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1966

def create_my_customer_secret_key(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_customer_secret_key.' if logger


  path = '/admin/v1/MyCustomerSecretKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_customer_secret_key])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_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::IdentityDomains::Models::MyCustomerSecretKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_o_auth2_client_credential(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_o_auth2_client_credential API.

Create a user's own OAuth2 client credential.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_o_auth2_client_credential (OCI::IdentityDomains::Models::MyOAuth2ClientCredential) —

  MyOAuth2ClientCredential schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyOAuth2ClientCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2036

def create_my_o_auth2_client_credential(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_o_auth2_client_credential.' if logger


  path = '/admin/v1/MyOAuth2ClientCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_o_auth2_client_credential])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_o_auth2_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::IdentityDomains::Models::MyOAuth2ClientCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_request(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_request API.

Create a Request

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :my_request (OCI::IdentityDomains::Models::MyRequest) —

  MyRequest schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyRequest

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2109

def create_my_request(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_request.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/MyRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_request') 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::IdentityDomains::Models::MyRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_smtp_credential(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_smtp_credential API.

Create a user's own SMTP credential.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_smtp_credential (OCI::IdentityDomains::Models::MySmtpCredential) —

  MySmtpCredential schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MySmtpCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2191

def create_my_smtp_credential(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_smtp_credential.' if logger


  path = '/admin/v1/MySmtpCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_smtp_credential])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_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::IdentityDomains::Models::MySmtpCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_support_account(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_support_account API.

Create a user's own support account.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_support_account (OCI::IdentityDomains::Models::MySupportAccount) —

  MySupportAccount schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MySupportAccount

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2261

def create_my_support_account(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_support_account.' if logger


  path = '/admin/v1/MySupportAccounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_support_account])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_support_account') 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::IdentityDomains::Models::MySupportAccount'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_my_user_db_credential(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_my_user_db_credential API.

Create a user's own database (DB) credential.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_user_db_credential (OCI::IdentityDomains::Models::MyUserDbCredential) —

  MyUserDbCredentials schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyUserDbCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2331

def create_my_user_db_credential(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_my_user_db_credential.' if logger


  path = '/admin/v1/MyUserDbCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_user_db_credential])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_my_user_db_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::IdentityDomains::Models::MyUserDbCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_network_perimeter(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_network_perimeter API.

Create a NetworkPerimeter

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :network_perimeter (OCI::IdentityDomains::Models::NetworkPerimeter) —

  NetworkPerimeter schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type NetworkPerimeter

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2404

def create_network_perimeter(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_network_perimeter.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/NetworkPerimeters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:network_perimeter])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_network_perimeter') 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::IdentityDomains::Models::NetworkPerimeter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_o_auth2_client_credential(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_o_auth2_client_credential API.

Add a user's OAuth2 client credentials.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :o_auth2_client_credential (OCI::IdentityDomains::Models::OAuth2ClientCredential) —

  OAuth2ClientCredential schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuth2ClientCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2489

def create_o_auth2_client_credential(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_o_auth2_client_credential.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/OAuth2ClientCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:o_auth2_client_credential])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_o_auth2_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::IdentityDomains::Models::OAuth2ClientCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_o_auth_client_certificate(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_o_auth_client_certificate API.

Create an OAuth Client Certificate

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :o_auth_client_certificate (OCI::IdentityDomains::Models::OAuthClientCertificate) —

  OAuthClientCertificate schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuthClientCertificate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2571

def create_o_auth_client_certificate(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_o_auth_client_certificate.' if logger


  path = '/admin/v1/OAuthClientCertificates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:o_auth_client_certificate])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_o_auth_client_certificate') 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::IdentityDomains::Models::OAuthClientCertificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_o_auth_partner_certificate(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_o_auth_partner_certificate API.

Create an OAuth Partner Certificate

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :o_auth_partner_certificate (OCI::IdentityDomains::Models::OAuthPartnerCertificate) —

  OAuthPartnerCertificate schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuthPartnerCertificate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2641

def create_o_auth_partner_certificate(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_o_auth_partner_certificate.' if logger


  path = '/admin/v1/OAuthPartnerCertificates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:o_auth_partner_certificate])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_o_auth_partner_certificate') 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::IdentityDomains::Models::OAuthPartnerCertificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_password_policy(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_password_policy API.

Create a password policy.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :password_policy (OCI::IdentityDomains::Models::PasswordPolicy) —

  PasswordPolicy schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type PasswordPolicy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2714

def create_password_policy(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_password_policy.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/PasswordPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:password_policy])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_password_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::IdentityDomains::Models::PasswordPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_policy(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_policy API.

Create a Policy

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :policy (OCI::IdentityDomains::Models::Policy) —

  Policy schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Policy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2799

def create_policy(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_policy.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Policies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:policy])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::Policy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_rule(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_rule API.

Create a Rule

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :rule (OCI::IdentityDomains::Models::Rule) —

  Rule schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Rule

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2884

def create_rule(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_rule.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Rules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:rule])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_rule') 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::IdentityDomains::Models::Rule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_question(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_security_question API.

Create a security question.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :security_question (OCI::IdentityDomains::Models::SecurityQuestion) —

  SecurityQuestion schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SecurityQuestion

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2969

def create_security_question(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_security_question.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SecurityQuestions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:security_question])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_security_question') 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::IdentityDomains::Models::SecurityQuestion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_self_registration_profile(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_self_registration_profile API.

Create a self-registration profile.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :self_registration_profile (OCI::IdentityDomains::Models::SelfRegistrationProfile) —

  SelfRegistrationProfile schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SelfRegistrationProfile

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3054

def create_self_registration_profile(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_self_registration_profile.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SelfRegistrationProfiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:self_registration_profile])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_self_registration_profile') 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::IdentityDomains::Models::SelfRegistrationProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_smtp_credential(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_smtp_credential API.

Create a user's SMTP credentials.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :smtp_credential (OCI::IdentityDomains::Models::SmtpCredential) —

  SmtpCredential schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SmtpCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3139

def create_smtp_credential(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_smtp_credential.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SmtpCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:smtp_credential])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::SmtpCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_user(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_user API.

Create a user.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :user (OCI::IdentityDomains::Models::User) —

  User schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type User

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3224

def create_user(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_user.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Users'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::User'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_user_db_credential(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_user_db_credential API.

Create a user's database (DB) credentials.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :user_db_credential (OCI::IdentityDomains::Models::UserDbCredential) —

  UserDbCredentials schema.

  Before you specify an attribute-value in a request to create a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserDbCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3309

def create_user_db_credential(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_user_db_credential.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/UserDbCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_db_credential])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_user_db_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::IdentityDomains::Models::UserDbCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_api_key(api_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_api_key API.

Delete a user's API key.

Parameters:

• api_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3380

def delete_api_key(api_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_api_key.' if logger

  raise "Missing the required parameter 'api_key_id' when calling delete_api_key." if api_key_id.nil?
  raise "Parameter value for 'api_key_id' must not be blank" if OCI::Internal::Util.blank_string?(api_key_id)

  path = '/admin/v1/ApiKeys/{apiKeyId}'.sub('{apiKeyId}', api_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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_app(app_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_app API.

Delete an App

Parameters:

• app_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3442

def delete_app(app_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_app.' if logger

  raise "Missing the required parameter 'app_id' when calling delete_app." if app_id.nil?
  raise "Parameter value for 'app_id' must not be blank" if OCI::Internal::Util.blank_string?(app_id)

  path = '/admin/v1/Apps/{appId}'.sub('{appId}', app_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_app') 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_app_role(app_role_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_app_role API.

Delete an AppRole

Parameters:

• app_role_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3504

def delete_app_role(app_role_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_app_role.' if logger

  raise "Missing the required parameter 'app_role_id' when calling delete_app_role." if app_role_id.nil?
  raise "Parameter value for 'app_role_id' must not be blank" if OCI::Internal::Util.blank_string?(app_role_id)

  path = '/admin/v1/AppRoles/{appRoleId}'.sub('{appRoleId}', app_role_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_app_role') 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_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_approval_workflow API.

Delete ApprovalWorkflow

Parameters:

• approval_workflow_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3566

def delete_approval_workflow(approval_workflow_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_approval_workflow.' if logger

  raise "Missing the required parameter 'approval_workflow_id' when calling delete_approval_workflow." if approval_workflow_id.nil?
  raise "Parameter value for 'approval_workflow_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_id)

  path = '/admin/v1/ApprovalWorkflows/{approvalWorkflowId}'.sub('{approvalWorkflowId}', approval_workflow_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_approval_workflow') 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_approval_workflow_assignment(approval_workflow_assignment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_approval_workflow_assignment API.

Delete Approval Workflow Assignment

Parameters:

• approval_workflow_assignment_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3628

def delete_approval_workflow_assignment(approval_workflow_assignment_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_approval_workflow_assignment.' if logger

  raise "Missing the required parameter 'approval_workflow_assignment_id' when calling delete_approval_workflow_assignment." if approval_workflow_assignment_id.nil?
  raise "Parameter value for 'approval_workflow_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_assignment_id)

  path = '/admin/v1/ApprovalWorkflowAssignments/{approvalWorkflowAssignmentId}'.sub('{approvalWorkflowAssignmentId}', approval_workflow_assignment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_approval_workflow_assignment') 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_approval_workflow_step(approval_workflow_step_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_approval_workflow_step API.

Delete ApprovalWorkflowStep

Parameters:

• approval_workflow_step_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3690

def delete_approval_workflow_step(approval_workflow_step_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_approval_workflow_step.' if logger

  raise "Missing the required parameter 'approval_workflow_step_id' when calling delete_approval_workflow_step." if approval_workflow_step_id.nil?
  raise "Parameter value for 'approval_workflow_step_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_step_id)

  path = '/admin/v1/ApprovalWorkflowSteps/{approvalWorkflowStepId}'.sub('{approvalWorkflowStepId}', approval_workflow_step_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_approval_workflow_step') 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(auth_token_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_auth_token API.

Delete a user's Auth token.

Parameters:

• auth_token_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3752

def delete_auth_token(auth_token_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_auth_token.' if logger

  raise "Missing the required parameter 'auth_token_id' when calling delete_auth_token." if auth_token_id.nil?
  raise "Parameter value for 'auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(auth_token_id)

  path = '/admin/v1/AuthTokens/{authTokenId}'.sub('{authTokenId}', auth_token_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_cloud_gate API.

Delete a Cloud Gate

Parameters:

• cloud_gate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3814

def delete_cloud_gate(cloud_gate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_cloud_gate.' if logger

  raise "Missing the required parameter 'cloud_gate_id' when calling delete_cloud_gate." if cloud_gate_id.nil?
  raise "Parameter value for 'cloud_gate_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_id)

  path = '/admin/v1/CloudGates/{cloudGateId}'.sub('{cloudGateId}', cloud_gate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_cloud_gate') 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_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_cloud_gate_mapping API.

Delete a Cloud Gate mapping

Parameters:

• cloud_gate_mapping_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3876

def delete_cloud_gate_mapping(cloud_gate_mapping_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_cloud_gate_mapping.' if logger

  raise "Missing the required parameter 'cloud_gate_mapping_id' when calling delete_cloud_gate_mapping." if cloud_gate_mapping_id.nil?
  raise "Parameter value for 'cloud_gate_mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_mapping_id)

  path = '/admin/v1/CloudGateMappings/{cloudGateMappingId}'.sub('{cloudGateMappingId}', cloud_gate_mapping_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_cloud_gate_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_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_cloud_gate_server API.

Delete a Cloud Gate server

Parameters:

• cloud_gate_server_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3938

def delete_cloud_gate_server(cloud_gate_server_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_cloud_gate_server.' if logger

  raise "Missing the required parameter 'cloud_gate_server_id' when calling delete_cloud_gate_server." if cloud_gate_server_id.nil?
  raise "Parameter value for 'cloud_gate_server_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_server_id)

  path = '/admin/v1/CloudGateServers/{cloudGateServerId}'.sub('{cloudGateServerId}', cloud_gate_server_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_cloud_gate_server') 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_condition(condition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_condition API.

Delete a Condition

Parameters:

• condition_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4000

def delete_condition(condition_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_condition.' if logger

  raise "Missing the required parameter 'condition_id' when calling delete_condition." if condition_id.nil?
  raise "Parameter value for 'condition_id' must not be blank" if OCI::Internal::Util.blank_string?(condition_id)

  path = '/admin/v1/Conditions/{conditionId}'.sub('{conditionId}', condition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_condition') 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(customer_secret_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_customer_secret_key API.

Delete a user's customer secret key.

Parameters:

• customer_secret_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4062

def delete_customer_secret_key(customer_secret_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_customer_secret_key.' if logger

  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 'customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(customer_secret_key_id)

  path = '/admin/v1/CustomerSecretKeys/{customerSecretKeyId}'.sub('{customerSecretKeyId}', customer_secret_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_dynamic_resource_group API.

Delete a Dynamic Resource Group.

Parameters:

• dynamic_resource_group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4124

def delete_dynamic_resource_group(dynamic_resource_group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_dynamic_resource_group.' if logger

  raise "Missing the required parameter 'dynamic_resource_group_id' when calling delete_dynamic_resource_group." if dynamic_resource_group_id.nil?
  raise "Parameter value for 'dynamic_resource_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_resource_group_id)

  path = '/admin/v1/DynamicResourceGroups/{dynamicResourceGroupId}'.sub('{dynamicResourceGroupId}', dynamic_resource_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_dynamic_resource_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_grant(grant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_grant API.

Remove a Grantee from an AppRole

Parameters:

• grant_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4186

def delete_grant(grant_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_grant.' if logger

  raise "Missing the required parameter 'grant_id' when calling delete_grant." if grant_id.nil?
  raise "Parameter value for 'grant_id' must not be blank" if OCI::Internal::Util.blank_string?(grant_id)

  path = '/admin/v1/Grants/{grantId}'.sub('{grantId}', grant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_grant') 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

Note:

Click here to see an example of how to use delete_group API.

Delete a group.

Parameters:

• group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4248

def delete_group(group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#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 = '/admin/v1/Groups/{groupId}'.sub('{groupId}', group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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

Note:

Click here to see an example of how to use delete_identity_provider API.

Delete an Identity Provider

Parameters:

• identity_provider_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4310

def delete_identity_provider(identity_provider_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#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 = '/admin/v1/IdentityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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_my_api_key(my_api_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_api_key API.

Delete a user's own API key.

Parameters:

• my_api_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4372

def delete_my_api_key(my_api_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_api_key.' if logger

  raise "Missing the required parameter 'my_api_key_id' when calling delete_my_api_key." if my_api_key_id.nil?
  raise "Parameter value for 'my_api_key_id' must not be blank" if OCI::Internal::Util.blank_string?(my_api_key_id)

  path = '/admin/v1/MyApiKeys/{myApiKeyId}'.sub('{myApiKeyId}', my_api_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_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_my_auth_token(my_auth_token_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_auth_token API.

Delete a user's own Auth token.

Parameters:

• my_auth_token_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4434

def delete_my_auth_token(my_auth_token_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_auth_token.' if logger

  raise "Missing the required parameter 'my_auth_token_id' when calling delete_my_auth_token." if my_auth_token_id.nil?
  raise "Parameter value for 'my_auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(my_auth_token_id)

  path = '/admin/v1/MyAuthTokens/{myAuthTokenId}'.sub('{myAuthTokenId}', my_auth_token_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_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_my_customer_secret_key(my_customer_secret_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_customer_secret_key API.

Delete a user's own customer secret key.

Parameters:

• my_customer_secret_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4496

def delete_my_customer_secret_key(my_customer_secret_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_customer_secret_key.' if logger

  raise "Missing the required parameter 'my_customer_secret_key_id' when calling delete_my_customer_secret_key." if my_customer_secret_key_id.nil?
  raise "Parameter value for 'my_customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(my_customer_secret_key_id)

  path = '/admin/v1/MyCustomerSecretKeys/{myCustomerSecretKeyId}'.sub('{myCustomerSecretKeyId}', my_customer_secret_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_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_my_device(my_device_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_device API.

Delete a Device

Parameters:

• my_device_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4558

def delete_my_device(my_device_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_device.' if logger

  raise "Missing the required parameter 'my_device_id' when calling delete_my_device." if my_device_id.nil?
  raise "Parameter value for 'my_device_id' must not be blank" if OCI::Internal::Util.blank_string?(my_device_id)

  path = '/admin/v1/MyDevices/{myDeviceId}'.sub('{myDeviceId}', my_device_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_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_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_o_auth2_client_credential API.

Delete a user's own OAuth2 client credential.

Parameters:

• my_o_auth2_client_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4620

def delete_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_o_auth2_client_credential.' if logger

  raise "Missing the required parameter 'my_o_auth2_client_credential_id' when calling delete_my_o_auth2_client_credential." if my_o_auth2_client_credential_id.nil?
  raise "Parameter value for 'my_o_auth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_o_auth2_client_credential_id)

  path = '/admin/v1/MyOAuth2ClientCredentials/{myOAuth2ClientCredentialId}'.sub('{myOAuth2ClientCredentialId}', my_o_auth2_client_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_o_auth2_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_my_smtp_credential(my_smtp_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_smtp_credential API.

Delete a user's own SMTP credential.

Parameters:

• my_smtp_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4682

def delete_my_smtp_credential(my_smtp_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_smtp_credential.' if logger

  raise "Missing the required parameter 'my_smtp_credential_id' when calling delete_my_smtp_credential." if my_smtp_credential_id.nil?
  raise "Parameter value for 'my_smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_smtp_credential_id)

  path = '/admin/v1/MySmtpCredentials/{mySmtpCredentialId}'.sub('{mySmtpCredentialId}', my_smtp_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_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_my_support_account(my_support_account_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_support_account API.

Delete a user's own support account.

Parameters:

• my_support_account_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4744

def delete_my_support_account(my_support_account_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_support_account.' if logger

  raise "Missing the required parameter 'my_support_account_id' when calling delete_my_support_account." if my_support_account_id.nil?
  raise "Parameter value for 'my_support_account_id' must not be blank" if OCI::Internal::Util.blank_string?(my_support_account_id)

  path = '/admin/v1/MySupportAccounts/{mySupportAccountId}'.sub('{mySupportAccountId}', my_support_account_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_support_account') 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_my_trusted_user_agent(my_trusted_user_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_trusted_user_agent API.

Delete a Trusted User Agent

Parameters:

• my_trusted_user_agent_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4806

def delete_my_trusted_user_agent(my_trusted_user_agent_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_trusted_user_agent.' if logger

  raise "Missing the required parameter 'my_trusted_user_agent_id' when calling delete_my_trusted_user_agent." if my_trusted_user_agent_id.nil?
  raise "Parameter value for 'my_trusted_user_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(my_trusted_user_agent_id)

  path = '/admin/v1/MyTrustedUserAgents/{myTrustedUserAgentId}'.sub('{myTrustedUserAgentId}', my_trusted_user_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_trusted_user_agent') 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_my_user_db_credential(my_user_db_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_my_user_db_credential API.

Delete a user's own database (DB) credential.

Parameters:

• my_user_db_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4868

def delete_my_user_db_credential(my_user_db_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_my_user_db_credential.' if logger

  raise "Missing the required parameter 'my_user_db_credential_id' when calling delete_my_user_db_credential." if my_user_db_credential_id.nil?
  raise "Parameter value for 'my_user_db_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_user_db_credential_id)

  path = '/admin/v1/MyUserDbCredentials/{myUserDbCredentialId}'.sub('{myUserDbCredentialId}', my_user_db_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_my_user_db_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_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_network_perimeter API.

Delete a NetworkPerimeter

Parameters:

• network_perimeter_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4930

def delete_network_perimeter(network_perimeter_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_network_perimeter.' if logger

  raise "Missing the required parameter 'network_perimeter_id' when calling delete_network_perimeter." if network_perimeter_id.nil?
  raise "Parameter value for 'network_perimeter_id' must not be blank" if OCI::Internal::Util.blank_string?(network_perimeter_id)

  path = '/admin/v1/NetworkPerimeters/{networkPerimeterId}'.sub('{networkPerimeterId}', network_perimeter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_network_perimeter') 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_auth2_client_credential(o_auth2_client_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_o_auth2_client_credential API.

Delete a user's OAuth2 client credentials.

Parameters:

• o_auth2_client_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 4992

def delete_o_auth2_client_credential(o_auth2_client_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_o_auth2_client_credential.' if logger

  raise "Missing the required parameter 'o_auth2_client_credential_id' when calling delete_o_auth2_client_credential." if o_auth2_client_credential_id.nil?
  raise "Parameter value for 'o_auth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth2_client_credential_id)

  path = '/admin/v1/OAuth2ClientCredentials/{oAuth2ClientCredentialId}'.sub('{oAuth2ClientCredentialId}', o_auth2_client_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_o_auth2_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_o_auth_client_certificate(o_auth_client_certificate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_o_auth_client_certificate API.

Delete an OAuth Client Certificate

Parameters:

• o_auth_client_certificate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5054

def delete_o_auth_client_certificate(o_auth_client_certificate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_o_auth_client_certificate.' if logger

  raise "Missing the required parameter 'o_auth_client_certificate_id' when calling delete_o_auth_client_certificate." if o_auth_client_certificate_id.nil?
  raise "Parameter value for 'o_auth_client_certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth_client_certificate_id)

  path = '/admin/v1/OAuthClientCertificates/{oAuthClientCertificateId}'.sub('{oAuthClientCertificateId}', o_auth_client_certificate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_o_auth_client_certificate') 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_partner_certificate(o_auth_partner_certificate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_o_auth_partner_certificate API.

Delete an OAuth Partner Certificate

Parameters:

• o_auth_partner_certificate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5116

def delete_o_auth_partner_certificate(o_auth_partner_certificate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_o_auth_partner_certificate.' if logger

  raise "Missing the required parameter 'o_auth_partner_certificate_id' when calling delete_o_auth_partner_certificate." if o_auth_partner_certificate_id.nil?
  raise "Parameter value for 'o_auth_partner_certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth_partner_certificate_id)

  path = '/admin/v1/OAuthPartnerCertificates/{oAuthPartnerCertificateId}'.sub('{oAuthPartnerCertificateId}', o_auth_partner_certificate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_o_auth_partner_certificate') 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_password_policy(password_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_password_policy API.

Delete a password policy.

Parameters:

• password_policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5178

def delete_password_policy(password_policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_password_policy.' if logger

  raise "Missing the required parameter 'password_policy_id' when calling delete_password_policy." if password_policy_id.nil?
  raise "Parameter value for 'password_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(password_policy_id)

  path = '/admin/v1/PasswordPolicies/{passwordPolicyId}'.sub('{passwordPolicyId}', password_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_password_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_policy(policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_policy API.

Delete a Policy

Parameters:

• policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5240

def delete_policy(policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#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 = '/admin/v1/Policies/{policyId}'.sub('{policyId}', policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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_rule(rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_rule API.

Delete a Rule

Parameters:

• rule_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5302

def delete_rule(rule_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_rule.' if logger

  raise "Missing the required parameter 'rule_id' when calling delete_rule." if rule_id.nil?
  raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id)

  path = '/admin/v1/Rules/{ruleId}'.sub('{ruleId}', rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_rule') 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_security_question(security_question_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_question API.

Delete a security question.

Parameters:

• security_question_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5364

def delete_security_question(security_question_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_security_question.' if logger

  raise "Missing the required parameter 'security_question_id' when calling delete_security_question." if security_question_id.nil?
  raise "Parameter value for 'security_question_id' must not be blank" if OCI::Internal::Util.blank_string?(security_question_id)

  path = '/admin/v1/SecurityQuestions/{securityQuestionId}'.sub('{securityQuestionId}', security_question_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_security_question') 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_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_self_registration_profile API.

Delete a self-registration profile.

Parameters:

• self_registration_profile_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5426

def delete_self_registration_profile(self_registration_profile_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_self_registration_profile.' if logger

  raise "Missing the required parameter 'self_registration_profile_id' when calling delete_self_registration_profile." if self_registration_profile_id.nil?
  raise "Parameter value for 'self_registration_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(self_registration_profile_id)

  path = '/admin/v1/SelfRegistrationProfiles/{selfRegistrationProfileId}'.sub('{selfRegistrationProfileId}', self_registration_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_self_registration_profile') 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(smtp_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_smtp_credential API.

Delete a user's SMTP credentials.

Parameters:

• smtp_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5488

def delete_smtp_credential(smtp_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_smtp_credential.' if logger

  raise "Missing the required parameter 'smtp_credential_id' when calling delete_smtp_credential." if smtp_credential_id.nil?
  raise "Parameter value for 'smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(smtp_credential_id)

  path = '/admin/v1/SmtpCredentials/{smtpCredentialId}'.sub('{smtpCredentialId}', smtp_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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_user(user_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_user API.

Delete a user.

Parameters:

• user_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5550

def delete_user(user_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#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 = '/admin/v1/Users/{userId}'.sub('{userId}', user_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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

#delete_user_db_credential(user_db_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_user_db_credential API.

Delete a user's database (DB) credentials.

Parameters:

• user_db_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :force_delete (BOOLEAN) —

  To force delete the resource and all its references (if any).

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5612

def delete_user_db_credential(user_db_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#delete_user_db_credential.' if logger

  raise "Missing the required parameter 'user_db_credential_id' when calling delete_user_db_credential." if user_db_credential_id.nil?
  raise "Parameter value for 'user_db_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(user_db_credential_id)

  path = '/admin/v1/UserDbCredentials/{userDbCredentialId}'.sub('{userDbCredentialId}', user_db_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:forceDelete] = opts[:force_delete] if !opts[:force_delete].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#delete_user_db_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

#get_account_mgmt_info(account_mgmt_info_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_account_mgmt_info API.

Get Account Mgmt Info

Parameters:

• account_mgmt_info_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AccountMgmtInfo

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5675

def get_account_mgmt_info(account_mgmt_info_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_account_mgmt_info.' if logger

  raise "Missing the required parameter 'account_mgmt_info_id' when calling get_account_mgmt_info." if account_mgmt_info_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'account_mgmt_info_id' must not be blank" if OCI::Internal::Util.blank_string?(account_mgmt_info_id)

  path = '/admin/v1/AccountMgmtInfos/{accountMgmtInfoId}'.sub('{accountMgmtInfoId}', account_mgmt_info_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_account_mgmt_info') 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::IdentityDomains::Models::AccountMgmtInfo'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_account_recovery_setting(account_recovery_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_account_recovery_setting API.

Get an account recovery setting.

Parameters:

• account_recovery_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AccountRecoverySetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5749

def get_account_recovery_setting(account_recovery_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_account_recovery_setting.' if logger

  raise "Missing the required parameter 'account_recovery_setting_id' when calling get_account_recovery_setting." if account_recovery_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'account_recovery_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(account_recovery_setting_id)

  path = '/admin/v1/AccountRecoverySettings/{accountRecoverySettingId}'.sub('{accountRecoverySettingId}', account_recovery_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_account_recovery_setting') 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::IdentityDomains::Models::AccountRecoverySetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_api_key(api_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_api_key API.

Get a user's API key.

Parameters:

• api_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApiKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5823

def get_api_key(api_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_api_key.' if logger

  raise "Missing the required parameter 'api_key_id' when calling get_api_key." if api_key_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'api_key_id' must not be blank" if OCI::Internal::Util.blank_string?(api_key_id)

  path = '/admin/v1/ApiKeys/{apiKeyId}'.sub('{apiKeyId}', api_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_api_key') 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::IdentityDomains::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_app(app_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_app API.

Get an App

Parameters:

• app_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type App

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5897

def get_app(app_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_app.' if logger

  raise "Missing the required parameter 'app_id' when calling get_app." if app_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'app_id' must not be blank" if OCI::Internal::Util.blank_string?(app_id)

  path = '/admin/v1/Apps/{appId}'.sub('{appId}', app_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_app') 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::IdentityDomains::Models::App'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_app_role(app_role_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_app_role API.

Get an AppRole

Parameters:

• app_role_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AppRole

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 5971

def get_app_role(app_role_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_app_role.' if logger

  raise "Missing the required parameter 'app_role_id' when calling get_app_role." if app_role_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'app_role_id' must not be blank" if OCI::Internal::Util.blank_string?(app_role_id)

  path = '/admin/v1/AppRoles/{appRoleId}'.sub('{appRoleId}', app_role_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_app_role') 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::IdentityDomains::Models::AppRole'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_approval_workflow API.

Get ApprovalWorkflow

Parameters:

• approval_workflow_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflow

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6045

def get_approval_workflow(approval_workflow_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_approval_workflow.' if logger

  raise "Missing the required parameter 'approval_workflow_id' when calling get_approval_workflow." if approval_workflow_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'approval_workflow_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_id)

  path = '/admin/v1/ApprovalWorkflows/{approvalWorkflowId}'.sub('{approvalWorkflowId}', approval_workflow_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_approval_workflow') 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::IdentityDomains::Models::ApprovalWorkflow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_approval_workflow_assignment(approval_workflow_assignment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_approval_workflow_assignment API.

Get an Approval Workflow Assignment

Parameters:

• approval_workflow_assignment_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowAssignment

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6119

def get_approval_workflow_assignment(approval_workflow_assignment_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_approval_workflow_assignment.' if logger

  raise "Missing the required parameter 'approval_workflow_assignment_id' when calling get_approval_workflow_assignment." if approval_workflow_assignment_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'approval_workflow_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_assignment_id)

  path = '/admin/v1/ApprovalWorkflowAssignments/{approvalWorkflowAssignmentId}'.sub('{approvalWorkflowAssignmentId}', approval_workflow_assignment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_approval_workflow_assignment') 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::IdentityDomains::Models::ApprovalWorkflowAssignment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_approval_workflow_step(approval_workflow_step_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_approval_workflow_step API.

Get ApprovalWorkflowStep

Parameters:

• approval_workflow_step_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowStep

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6193

def get_approval_workflow_step(approval_workflow_step_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_approval_workflow_step.' if logger

  raise "Missing the required parameter 'approval_workflow_step_id' when calling get_approval_workflow_step." if approval_workflow_step_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'approval_workflow_step_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_step_id)

  path = '/admin/v1/ApprovalWorkflowSteps/{approvalWorkflowStepId}'.sub('{approvalWorkflowStepId}', approval_workflow_step_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_approval_workflow_step') 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::IdentityDomains::Models::ApprovalWorkflowStep'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_auth_token(auth_token_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_auth_token API.

Get a user's Auth token.

Parameters:

• auth_token_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AuthToken

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6267

def get_auth_token(auth_token_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_auth_token.' if logger

  raise "Missing the required parameter 'auth_token_id' when calling get_auth_token." if auth_token_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(auth_token_id)

  path = '/admin/v1/AuthTokens/{authTokenId}'.sub('{authTokenId}', auth_token_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_auth_token') 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::IdentityDomains::Models::AuthToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_authentication_factor_setting(authentication_factor_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_authentication_factor_setting API.

Get Authentication Factor Settings

Parameters:

• authentication_factor_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AuthenticationFactorSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6341

def get_authentication_factor_setting(authentication_factor_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_authentication_factor_setting.' if logger

  raise "Missing the required parameter 'authentication_factor_setting_id' when calling get_authentication_factor_setting." if authentication_factor_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'authentication_factor_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_factor_setting_id)

  path = '/admin/v1/AuthenticationFactorSettings/{authenticationFactorSettingId}'.sub('{authenticationFactorSettingId}', authentication_factor_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_authentication_factor_setting') 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::IdentityDomains::Models::AuthenticationFactorSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_branding_setting(branding_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_branding_setting API.

Get Branding Settings

Parameters:

• branding_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type BrandingSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6415

def get_branding_setting(branding_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_branding_setting.' if logger

  raise "Missing the required parameter 'branding_setting_id' when calling get_branding_setting." if branding_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'branding_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(branding_setting_id)

  path = '/admin/v1/BrandingSettings/{brandingSettingId}'.sub('{brandingSettingId}', branding_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_branding_setting') 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::IdentityDomains::Models::BrandingSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cloud_gate API.

Get a Cloud Gate

Parameters:

• cloud_gate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6489

def get_cloud_gate(cloud_gate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_cloud_gate.' if logger

  raise "Missing the required parameter 'cloud_gate_id' when calling get_cloud_gate." if cloud_gate_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_id)

  path = '/admin/v1/CloudGates/{cloudGateId}'.sub('{cloudGateId}', cloud_gate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_cloud_gate') 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::IdentityDomains::Models::CloudGate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cloud_gate_mapping API.

Get a Cloud Gate mapping

Parameters:

• cloud_gate_mapping_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateMapping

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6563

def get_cloud_gate_mapping(cloud_gate_mapping_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_cloud_gate_mapping.' if logger

  raise "Missing the required parameter 'cloud_gate_mapping_id' when calling get_cloud_gate_mapping." if cloud_gate_mapping_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_mapping_id)

  path = '/admin/v1/CloudGateMappings/{cloudGateMappingId}'.sub('{cloudGateMappingId}', cloud_gate_mapping_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_cloud_gate_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::IdentityDomains::Models::CloudGateMapping'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cloud_gate_server API.

Get a Cloud Gate server

Parameters:

• cloud_gate_server_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateServer

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6637

def get_cloud_gate_server(cloud_gate_server_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_cloud_gate_server.' if logger

  raise "Missing the required parameter 'cloud_gate_server_id' when calling get_cloud_gate_server." if cloud_gate_server_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_server_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_server_id)

  path = '/admin/v1/CloudGateServers/{cloudGateServerId}'.sub('{cloudGateServerId}', cloud_gate_server_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_cloud_gate_server') 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::IdentityDomains::Models::CloudGateServer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_condition(condition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_condition API.

Get a Condition

Parameters:

• condition_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Condition

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6711

def get_condition(condition_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_condition.' if logger

  raise "Missing the required parameter 'condition_id' when calling get_condition." if condition_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'condition_id' must not be blank" if OCI::Internal::Util.blank_string?(condition_id)

  path = '/admin/v1/Conditions/{conditionId}'.sub('{conditionId}', condition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_condition') 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::IdentityDomains::Models::Condition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_customer_secret_key(customer_secret_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_customer_secret_key API.

Get a user's customer secret key.

Parameters:

• customer_secret_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CustomerSecretKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6785

def get_customer_secret_key(customer_secret_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_customer_secret_key.' if logger

  raise "Missing the required parameter 'customer_secret_key_id' when calling get_customer_secret_key." if customer_secret_key_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(customer_secret_key_id)

  path = '/admin/v1/CustomerSecretKeys/{customerSecretKeyId}'.sub('{customerSecretKeyId}', customer_secret_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_customer_secret_key') 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::IdentityDomains::Models::CustomerSecretKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_dynamic_resource_group API.

Get a Dynamic Resource Group.

Parameters:

• dynamic_resource_group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type DynamicResourceGroup

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6859

def get_dynamic_resource_group(dynamic_resource_group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_dynamic_resource_group.' if logger

  raise "Missing the required parameter 'dynamic_resource_group_id' when calling get_dynamic_resource_group." if dynamic_resource_group_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'dynamic_resource_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_resource_group_id)

  path = '/admin/v1/DynamicResourceGroups/{dynamicResourceGroupId}'.sub('{dynamicResourceGroupId}', dynamic_resource_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_dynamic_resource_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::IdentityDomains::Models::DynamicResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_grant(grant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_grant API.

Get a Grant

Parameters:

• grant_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Grant

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 6933

def get_grant(grant_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_grant.' if logger

  raise "Missing the required parameter 'grant_id' when calling get_grant." if grant_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'grant_id' must not be blank" if OCI::Internal::Util.blank_string?(grant_id)

  path = '/admin/v1/Grants/{grantId}'.sub('{grantId}', grant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_grant') 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::IdentityDomains::Models::Grant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_group(group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_group API.

Get a group. Important: The Group SEARCH and GET operations on users and members will throw an exception if the response has more than 10,000 members. To avoid the exception, use the pagination filter to GET or SEARCH group members.

Parameters:

• group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Group

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7007

def get_group(group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_group.' if logger

  raise "Missing the required parameter 'group_id' when calling get_group." if group_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'group_id' must not be blank" if OCI::Internal::Util.blank_string?(group_id)

  path = '/admin/v1/Groups/{groupId}'.sub('{groupId}', group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::Group'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_identity_provider(identity_provider_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_identity_provider API.

Get an Identity Provider

Parameters:

• identity_provider_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentityProvider

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7081

def get_identity_provider(identity_provider_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_identity_provider.' if logger

  raise "Missing the required parameter 'identity_provider_id' when calling get_identity_provider." if identity_provider_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id)

  path = '/admin/v1/IdentityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::IdentityProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_identity_setting(identity_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_identity_setting API.

Get an Identity setting.

Parameters:

• identity_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentitySetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7155

def get_identity_setting(identity_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_identity_setting.' if logger

  raise "Missing the required parameter 'identity_setting_id' when calling get_identity_setting." if identity_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'identity_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_setting_id)

  path = '/admin/v1/IdentitySettings/{identitySettingId}'.sub('{identitySettingId}', identity_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_identity_setting') 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::IdentityDomains::Models::IdentitySetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_kmsi_setting(kmsi_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_kmsi_setting API.

Get KmsiSettings

Parameters:

• kmsi_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type KmsiSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7229

def get_kmsi_setting(kmsi_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_kmsi_setting.' if logger

  raise "Missing the required parameter 'kmsi_setting_id' when calling get_kmsi_setting." if kmsi_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'kmsi_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(kmsi_setting_id)

  path = '/admin/v1/KmsiSettings/{kmsiSettingId}'.sub('{kmsiSettingId}', kmsi_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_kmsi_setting') 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::IdentityDomains::Models::KmsiSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_me(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_me API.

Get a user's own information.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Me

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7302

def get_me(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_me.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Me'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_me') 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::IdentityDomains::Models::Me'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_api_key(my_api_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_api_key API.

Get a user's own API key.

Parameters:

• my_api_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyApiKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7371

def get_my_api_key(my_api_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_api_key.' if logger

  raise "Missing the required parameter 'my_api_key_id' when calling get_my_api_key." if my_api_key_id.nil?
  raise "Parameter value for 'my_api_key_id' must not be blank" if OCI::Internal::Util.blank_string?(my_api_key_id)

  path = '/admin/v1/MyApiKeys/{myApiKeyId}'.sub('{myApiKeyId}', my_api_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_api_key') 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::IdentityDomains::Models::MyApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_auth_token(my_auth_token_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_auth_token API.

Get a user's own Auth token.

Parameters:

• my_auth_token_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyAuthToken

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7430

def get_my_auth_token(my_auth_token_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_auth_token.' if logger

  raise "Missing the required parameter 'my_auth_token_id' when calling get_my_auth_token." if my_auth_token_id.nil?
  raise "Parameter value for 'my_auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(my_auth_token_id)

  path = '/admin/v1/MyAuthTokens/{myAuthTokenId}'.sub('{myAuthTokenId}', my_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_auth_token') 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::IdentityDomains::Models::MyAuthToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_completed_approval(my_completed_approval_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_completed_approval API.

Get My MyCompletedApproval

Parameters:

• my_completed_approval_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyCompletedApproval

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7489

def get_my_completed_approval(my_completed_approval_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_completed_approval.' if logger

  raise "Missing the required parameter 'my_completed_approval_id' when calling get_my_completed_approval." if my_completed_approval_id.nil?
  raise "Parameter value for 'my_completed_approval_id' must not be blank" if OCI::Internal::Util.blank_string?(my_completed_approval_id)

  path = '/admin/v1/MyCompletedApprovals/{myCompletedApprovalId}'.sub('{myCompletedApprovalId}', my_completed_approval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_completed_approval') 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::IdentityDomains::Models::MyCompletedApproval'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_customer_secret_key(my_customer_secret_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_customer_secret_key API.

Get a user's own customer secret key.

Parameters:

• my_customer_secret_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyCustomerSecretKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7548

def get_my_customer_secret_key(my_customer_secret_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_customer_secret_key.' if logger

  raise "Missing the required parameter 'my_customer_secret_key_id' when calling get_my_customer_secret_key." if my_customer_secret_key_id.nil?
  raise "Parameter value for 'my_customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(my_customer_secret_key_id)

  path = '/admin/v1/MyCustomerSecretKeys/{myCustomerSecretKeyId}'.sub('{myCustomerSecretKeyId}', my_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_customer_secret_key') 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::IdentityDomains::Models::MyCustomerSecretKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_device(my_device_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_device API.

Get a Device

Parameters:

• my_device_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyDevice

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7610

def get_my_device(my_device_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_device.' if logger

  raise "Missing the required parameter 'my_device_id' when calling get_my_device." if my_device_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'my_device_id' must not be blank" if OCI::Internal::Util.blank_string?(my_device_id)

  path = '/admin/v1/MyDevices/{myDeviceId}'.sub('{myDeviceId}', my_device_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_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::IdentityDomains::Models::MyDevice'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_o_auth2_client_credential API.

Get a user's own OAuth2 client credential.

Parameters:

• my_o_auth2_client_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyOAuth2ClientCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7681

def get_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_o_auth2_client_credential.' if logger

  raise "Missing the required parameter 'my_o_auth2_client_credential_id' when calling get_my_o_auth2_client_credential." if my_o_auth2_client_credential_id.nil?
  raise "Parameter value for 'my_o_auth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_o_auth2_client_credential_id)

  path = '/admin/v1/MyOAuth2ClientCredentials/{myOAuth2ClientCredentialId}'.sub('{myOAuth2ClientCredentialId}', my_o_auth2_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_o_auth2_client_credential') 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::IdentityDomains::Models::MyOAuth2ClientCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_pending_approval(my_pending_approval_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_pending_approval API.

Get My MyPendingApproval

Parameters:

• my_pending_approval_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyPendingApproval

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7740

def get_my_pending_approval(my_pending_approval_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_pending_approval.' if logger

  raise "Missing the required parameter 'my_pending_approval_id' when calling get_my_pending_approval." if my_pending_approval_id.nil?
  raise "Parameter value for 'my_pending_approval_id' must not be blank" if OCI::Internal::Util.blank_string?(my_pending_approval_id)

  path = '/admin/v1/MyPendingApprovals/{myPendingApprovalId}'.sub('{myPendingApprovalId}', my_pending_approval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_pending_approval') 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::IdentityDomains::Models::MyPendingApproval'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_request(my_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_request API.

Get My Requests

Parameters:

• my_request_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyRequest

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7802

def get_my_request(my_request_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_request.' if logger

  raise "Missing the required parameter 'my_request_id' when calling get_my_request." if my_request_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'my_request_id' must not be blank" if OCI::Internal::Util.blank_string?(my_request_id)

  path = '/admin/v1/MyRequests/{myRequestId}'.sub('{myRequestId}', my_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_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::IdentityDomains::Models::MyRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_smtp_credential(my_smtp_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_smtp_credential API.

Get a user's own SMTP credential.

Parameters:

• my_smtp_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MySmtpCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7873

def get_my_smtp_credential(my_smtp_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_smtp_credential.' if logger

  raise "Missing the required parameter 'my_smtp_credential_id' when calling get_my_smtp_credential." if my_smtp_credential_id.nil?
  raise "Parameter value for 'my_smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_smtp_credential_id)

  path = '/admin/v1/MySmtpCredentials/{mySmtpCredentialId}'.sub('{mySmtpCredentialId}', my_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_smtp_credential') 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::IdentityDomains::Models::MySmtpCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_support_account(my_support_account_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_support_account API.

Get a user's own support account.

Parameters:

• my_support_account_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MySupportAccount

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7932

def get_my_support_account(my_support_account_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_support_account.' if logger

  raise "Missing the required parameter 'my_support_account_id' when calling get_my_support_account." if my_support_account_id.nil?
  raise "Parameter value for 'my_support_account_id' must not be blank" if OCI::Internal::Util.blank_string?(my_support_account_id)

  path = '/admin/v1/MySupportAccounts/{mySupportAccountId}'.sub('{mySupportAccountId}', my_support_account_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_support_account') 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::IdentityDomains::Models::MySupportAccount'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_trusted_user_agent(my_trusted_user_agent_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_trusted_user_agent API.

Get a Trusted User Agent

Parameters:

• my_trusted_user_agent_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyTrustedUserAgent

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 7994

def get_my_trusted_user_agent(my_trusted_user_agent_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_trusted_user_agent.' if logger

  raise "Missing the required parameter 'my_trusted_user_agent_id' when calling get_my_trusted_user_agent." if my_trusted_user_agent_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'my_trusted_user_agent_id' must not be blank" if OCI::Internal::Util.blank_string?(my_trusted_user_agent_id)

  path = '/admin/v1/MyTrustedUserAgents/{myTrustedUserAgentId}'.sub('{myTrustedUserAgentId}', my_trusted_user_agent_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_trusted_user_agent') 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::IdentityDomains::Models::MyTrustedUserAgent'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_my_user_db_credential(my_user_db_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_my_user_db_credential API.

Get a user's own database (DB) credential.

Parameters:

• my_user_db_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyUserDbCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8065

def get_my_user_db_credential(my_user_db_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_my_user_db_credential.' if logger

  raise "Missing the required parameter 'my_user_db_credential_id' when calling get_my_user_db_credential." if my_user_db_credential_id.nil?
  raise "Parameter value for 'my_user_db_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_user_db_credential_id)

  path = '/admin/v1/MyUserDbCredentials/{myUserDbCredentialId}'.sub('{myUserDbCredentialId}', my_user_db_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_my_user_db_credential') 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::IdentityDomains::Models::MyUserDbCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_network_perimeter API.

Get a NetworkPerimeter

Parameters:

• network_perimeter_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type NetworkPerimeter

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8127

def get_network_perimeter(network_perimeter_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_network_perimeter.' if logger

  raise "Missing the required parameter 'network_perimeter_id' when calling get_network_perimeter." if network_perimeter_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'network_perimeter_id' must not be blank" if OCI::Internal::Util.blank_string?(network_perimeter_id)

  path = '/admin/v1/NetworkPerimeters/{networkPerimeterId}'.sub('{networkPerimeterId}', network_perimeter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_network_perimeter') 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::IdentityDomains::Models::NetworkPerimeter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_notification_setting(notification_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_notification_setting API.

Get Notification Settings

Parameters:

• notification_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type NotificationSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8201

def get_notification_setting(notification_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_notification_setting.' if logger

  raise "Missing the required parameter 'notification_setting_id' when calling get_notification_setting." if notification_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'notification_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(notification_setting_id)

  path = '/admin/v1/NotificationSettings/{notificationSettingId}'.sub('{notificationSettingId}', notification_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_notification_setting') 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::IdentityDomains::Models::NotificationSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_o_auth2_client_credential(o_auth2_client_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_o_auth2_client_credential API.

Get a user's OAuth2 client credentials.

Parameters:

• o_auth2_client_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuth2ClientCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8275

def get_o_auth2_client_credential(o_auth2_client_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_o_auth2_client_credential.' if logger

  raise "Missing the required parameter 'o_auth2_client_credential_id' when calling get_o_auth2_client_credential." if o_auth2_client_credential_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'o_auth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth2_client_credential_id)

  path = '/admin/v1/OAuth2ClientCredentials/{oAuth2ClientCredentialId}'.sub('{oAuth2ClientCredentialId}', o_auth2_client_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_o_auth2_client_credential') 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::IdentityDomains::Models::OAuth2ClientCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_o_auth_client_certificate(o_auth_client_certificate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_o_auth_client_certificate API.

Get OAuth Client Certificates

Parameters:

• o_auth_client_certificate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuthClientCertificate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8346

def get_o_auth_client_certificate(o_auth_client_certificate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_o_auth_client_certificate.' if logger

  raise "Missing the required parameter 'o_auth_client_certificate_id' when calling get_o_auth_client_certificate." if o_auth_client_certificate_id.nil?
  raise "Parameter value for 'o_auth_client_certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth_client_certificate_id)

  path = '/admin/v1/OAuthClientCertificates/{oAuthClientCertificateId}'.sub('{oAuthClientCertificateId}', o_auth_client_certificate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_o_auth_client_certificate') 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::IdentityDomains::Models::OAuthClientCertificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_o_auth_partner_certificate(o_auth_partner_certificate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_o_auth_partner_certificate API.

Get an OAuth Partner Certificate

Parameters:

• o_auth_partner_certificate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuthPartnerCertificate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8405

def get_o_auth_partner_certificate(o_auth_partner_certificate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_o_auth_partner_certificate.' if logger

  raise "Missing the required parameter 'o_auth_partner_certificate_id' when calling get_o_auth_partner_certificate." if o_auth_partner_certificate_id.nil?
  raise "Parameter value for 'o_auth_partner_certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth_partner_certificate_id)

  path = '/admin/v1/OAuthPartnerCertificates/{oAuthPartnerCertificateId}'.sub('{oAuthPartnerCertificateId}', o_auth_partner_certificate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_o_auth_partner_certificate') 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::IdentityDomains::Models::OAuthPartnerCertificate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_password_policy(password_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_password_policy API.

Get a password policy.

Parameters:

• password_policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type PasswordPolicy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8467

def get_password_policy(password_policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_password_policy.' if logger

  raise "Missing the required parameter 'password_policy_id' when calling get_password_policy." if password_policy_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'password_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(password_policy_id)

  path = '/admin/v1/PasswordPolicies/{passwordPolicyId}'.sub('{passwordPolicyId}', password_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_password_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::IdentityDomains::Models::PasswordPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_policy(policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_policy API.

Get a Policy

Parameters:

• policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Policy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8541

def get_policy(policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_policy.' if logger

  raise "Missing the required parameter 'policy_id' when calling get_policy." if policy_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'policy_id' must not be blank" if OCI::Internal::Util.blank_string?(policy_id)

  path = '/admin/v1/Policies/{policyId}'.sub('{policyId}', policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::Policy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_rule(rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_rule API.

Get a Rule

Parameters:

• rule_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Rule

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8615

def get_rule(rule_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_rule.' if logger

  raise "Missing the required parameter 'rule_id' when calling get_rule." if rule_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id)

  path = '/admin/v1/Rules/{ruleId}'.sub('{ruleId}', rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_rule') 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::IdentityDomains::Models::Rule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_schema(schema_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_schema API.

Get a Schema

Parameters:

• schema_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Schema

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8686

def get_schema(schema_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_schema.' if logger

  raise "Missing the required parameter 'schema_id' when calling get_schema." if schema_id.nil?
  raise "Parameter value for 'schema_id' must not be blank" if OCI::Internal::Util.blank_string?(schema_id)

  path = '/admin/v1/Schemas/{schemaId}'.sub('{schemaId}', schema_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_schema') 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::IdentityDomains::Models::Schema'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_question(security_question_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_question API.

Get a security question.

Parameters:

• security_question_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SecurityQuestion

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8748

def get_security_question(security_question_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_security_question.' if logger

  raise "Missing the required parameter 'security_question_id' when calling get_security_question." if security_question_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'security_question_id' must not be blank" if OCI::Internal::Util.blank_string?(security_question_id)

  path = '/admin/v1/SecurityQuestions/{securityQuestionId}'.sub('{securityQuestionId}', security_question_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_security_question') 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::IdentityDomains::Models::SecurityQuestion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_question_setting(security_question_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_question_setting API.

Get a security question setting.

Parameters:

• security_question_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SecurityQuestionSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8822

def get_security_question_setting(security_question_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_security_question_setting.' if logger

  raise "Missing the required parameter 'security_question_setting_id' when calling get_security_question_setting." if security_question_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'security_question_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(security_question_setting_id)

  path = '/admin/v1/SecurityQuestionSettings/{securityQuestionSettingId}'.sub('{securityQuestionSettingId}', security_question_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_security_question_setting') 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::IdentityDomains::Models::SecurityQuestionSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_self_registration_profile API.

Get a self-registration profile.

Parameters:

• self_registration_profile_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SelfRegistrationProfile

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8896

def get_self_registration_profile(self_registration_profile_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_self_registration_profile.' if logger

  raise "Missing the required parameter 'self_registration_profile_id' when calling get_self_registration_profile." if self_registration_profile_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'self_registration_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(self_registration_profile_id)

  path = '/admin/v1/SelfRegistrationProfiles/{selfRegistrationProfileId}'.sub('{selfRegistrationProfileId}', self_registration_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_self_registration_profile') 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::IdentityDomains::Models::SelfRegistrationProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_setting(setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_setting API.

Get Settings

Parameters:

• setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Setting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 8970

def get_setting(setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_setting.' if logger

  raise "Missing the required parameter 'setting_id' when calling get_setting." if setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'setting_id' must not be blank" if OCI::Internal::Util.blank_string?(setting_id)

  path = '/admin/v1/Settings/{settingId}'.sub('{settingId}', setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_setting') 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::IdentityDomains::Models::Setting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_smtp_credential(smtp_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_smtp_credential API.

Get a user's SMTP credentials.

Parameters:

• smtp_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SmtpCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9044

def get_smtp_credential(smtp_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_smtp_credential.' if logger

  raise "Missing the required parameter 'smtp_credential_id' when calling get_smtp_credential." if smtp_credential_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(smtp_credential_id)

  path = '/admin/v1/SmtpCredentials/{smtpCredentialId}'.sub('{smtpCredentialId}', smtp_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_smtp_credential') 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::IdentityDomains::Models::SmtpCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user(user_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user API.

Get a user.

Parameters:

• user_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type User

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9118

def get_user(user_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_user.' if logger

  raise "Missing the required parameter 'user_id' when calling get_user." if user_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id)

  path = '/admin/v1/Users/{userId}'.sub('{userId}', user_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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::IdentityDomains::Models::User'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_attributes_setting(user_attributes_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user_attributes_setting API.

Get User Schema Attribute Settings

Parameters:

• user_attributes_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserAttributesSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9192

def get_user_attributes_setting(user_attributes_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_user_attributes_setting.' if logger

  raise "Missing the required parameter 'user_attributes_setting_id' when calling get_user_attributes_setting." if user_attributes_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_attributes_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(user_attributes_setting_id)

  path = '/admin/v1/UserAttributesSettings/{userAttributesSettingId}'.sub('{userAttributesSettingId}', user_attributes_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_user_attributes_setting') 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::IdentityDomains::Models::UserAttributesSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_user_db_credential(user_db_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_user_db_credential API.

Get a user's database (DB) credentials.

Parameters:

• user_db_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserDbCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9266

def get_user_db_credential(user_db_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#get_user_db_credential.' if logger

  raise "Missing the required parameter 'user_db_credential_id' when calling get_user_db_credential." if user_db_credential_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_db_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(user_db_credential_id)

  path = '/admin/v1/UserDbCredentials/{userDbCredentialId}'.sub('{userDbCredentialId}', user_db_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#get_user_db_credential') 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::IdentityDomains::Models::UserDbCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_account_mgmt_infos(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_account_mgmt_infos API.

Search Account Mgmt Info

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AccountMgmtInfos

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9346

def list_account_mgmt_infos(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_account_mgmt_infos.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AccountMgmtInfos'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_account_mgmt_infos') 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::IdentityDomains::Models::AccountMgmtInfos'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_account_recovery_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_account_recovery_settings API.

Search for account recovery settings.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AccountRecoverySettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9430

def list_account_recovery_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_account_recovery_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AccountRecoverySettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_account_recovery_settings') 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::IdentityDomains::Models::AccountRecoverySettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_api_keys(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_api_keys API.

Search API keys.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ApiKeys

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9510

def list_api_keys(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_api_keys.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApiKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::ApiKeys'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_app_roles(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_app_roles API.

Search AppRoles

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AppRoles

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9599

def list_app_roles(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_app_roles.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AppRoles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_app_roles') 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::IdentityDomains::Models::AppRoles'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_approval_workflow_assignments(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_approval_workflow_assignments API.

Search Approval Workflow Assignments

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowAssignments

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9688

def list_approval_workflow_assignments(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_approval_workflow_assignments.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApprovalWorkflowAssignments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_approval_workflow_assignments') 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::IdentityDomains::Models::ApprovalWorkflowAssignments'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_approval_workflow_steps(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_approval_workflow_steps API.

Search ApprovalWorkflowStep

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowSteps

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9777

def list_approval_workflow_steps(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_approval_workflow_steps.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApprovalWorkflowSteps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_approval_workflow_steps') 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::IdentityDomains::Models::ApprovalWorkflowSteps'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_approval_workflows(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_approval_workflows API.

Search ApprovalWorkflow

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflows

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9866

def list_approval_workflows(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_approval_workflows.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ApprovalWorkflows'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_approval_workflows') 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::IdentityDomains::Models::ApprovalWorkflows'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_apps(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_apps API.

Search Apps

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Apps

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 9955

def list_apps(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_apps.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Apps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_apps') 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::IdentityDomains::Models::Apps'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_auth_tokens(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_auth_tokens API.

Search for Auth tokens.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AuthTokens

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10044

def list_auth_tokens(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_auth_tokens.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AuthTokens'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::AuthTokens'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_authentication_factor_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_authentication_factor_settings API.

Search Authentication Factor Settings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AuthenticationFactorSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10128

def list_authentication_factor_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_authentication_factor_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/AuthenticationFactorSettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_authentication_factor_settings') 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::IdentityDomains::Models::AuthenticationFactorSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_branding_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_branding_settings API.

Search Branding Settings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type BrandingSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10203

def list_branding_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_branding_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/BrandingSettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_branding_settings') 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::IdentityDomains::Models::BrandingSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_gate_mappings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cloud_gate_mappings API.

Search Cloud Gate mappings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CloudGateMappings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10283

def list_cloud_gate_mappings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_cloud_gate_mappings.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CloudGateMappings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_cloud_gate_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: 'OCI::IdentityDomains::Models::CloudGateMappings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_gate_servers(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cloud_gate_servers API.

Search Cloud Gate servers

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CloudGateServers

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10372

def list_cloud_gate_servers(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_cloud_gate_servers.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CloudGateServers'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_cloud_gate_servers') 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::IdentityDomains::Models::CloudGateServers'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cloud_gates(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cloud_gates API.

Search Cloud Gates

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CloudGates

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10461

def list_cloud_gates(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_cloud_gates.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CloudGates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_cloud_gates') 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::IdentityDomains::Models::CloudGates'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_conditions(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_conditions API.

Search Conditions

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Conditions

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10550

def list_conditions(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_conditions.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Conditions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_conditions') 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::IdentityDomains::Models::Conditions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_customer_secret_keys(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_customer_secret_keys API.

Search for a user's customer secret keys.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CustomerSecretKeys

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10639

def list_customer_secret_keys(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_customer_secret_keys.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/CustomerSecretKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::CustomerSecretKeys'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_dynamic_resource_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_dynamic_resource_groups API.

Search for Dynamic Resource Groups.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type DynamicResourceGroups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10728

def list_dynamic_resource_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_dynamic_resource_groups.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/DynamicResourceGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_dynamic_resource_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: 'OCI::IdentityDomains::Models::DynamicResourceGroups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_grants(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_grants API.

Search Grants

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Grants

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10817

def list_grants(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_grants.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Grants'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_grants') 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::IdentityDomains::Models::Grants'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_groups API.

Search for groups. Important: The Group SEARCH and GET operations on users and members will throw an exception if the response has more than 10,000 members. To avoid the exception, use the pagination filter to GET or SEARCH group members.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Groups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10906

def list_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_groups.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Groups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::Groups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_identity_providers(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_identity_providers API.

Search Identity Providers

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type IdentityProviders

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 10995

def list_identity_providers(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_identity_providers.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/IdentityProviders'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::IdentityProviders'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_identity_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_identity_settings API.

Search for Identity settings.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type IdentitySettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11079

def list_identity_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_identity_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/IdentitySettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_identity_settings') 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::IdentityDomains::Models::IdentitySettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_kmsi_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_kmsi_settings API.

Search KmsiSettings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type KmsiSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11154

def list_kmsi_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_kmsi_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/KmsiSettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_kmsi_settings') 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::IdentityDomains::Models::KmsiSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_api_keys(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_api_keys API.

Search for a user's own API key.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyApiKeys

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11231

def list_my_api_keys(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_api_keys.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyApiKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MyApiKeys'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_apps(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_apps API.

Search My Apps

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyApps

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11305

def list_my_apps(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_apps.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyApps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_apps') 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::IdentityDomains::Models::MyApps'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_auth_tokens(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_auth_tokens API.

Search for a user's own Auth token.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyAuthTokens

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11379

def list_my_auth_tokens(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_auth_tokens.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyAuthTokens'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MyAuthTokens'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_completed_approvals(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_completed_approvals API.

Search My MyCompletedApproval

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyCompletedApprovals

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11453

def list_my_completed_approvals(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_completed_approvals.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyCompletedApprovals'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_completed_approvals') 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::IdentityDomains::Models::MyCompletedApprovals'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_customer_secret_keys(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_customer_secret_keys API.

Search for a user's own customer secret key.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyCustomerSecretKeys

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11527

def list_my_customer_secret_keys(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_customer_secret_keys.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyCustomerSecretKeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MyCustomerSecretKeys'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_devices(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_devices API.

Search Devices

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyDevices

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11604

def list_my_devices(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_devices.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/MyDevices'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MyDevices'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_groups API.

Search for 'My Groups'.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyGroups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11693

def list_my_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_groups.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/MyGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MyGroups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_o_auth2_client_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_o_auth2_client_credentials API.

Search for a user's own OAuth2 client credential.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyOAuth2ClientCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11779

def list_my_o_auth2_client_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_o_auth2_client_credentials.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyOAuth2ClientCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_o_auth2_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: 'OCI::IdentityDomains::Models::MyOAuth2ClientCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_pending_approvals(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_pending_approvals API.

Search My Approvals

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyPendingApprovals

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11853

def list_my_pending_approvals(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_pending_approvals.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyPendingApprovals'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_pending_approvals') 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::IdentityDomains::Models::MyPendingApprovals'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_requestable_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_requestable_groups API.

Search My Requestable Groups

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyRequestableGroups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 11927

def list_my_requestable_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_requestable_groups.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyRequestableGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_requestable_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: 'OCI::IdentityDomains::Models::MyRequestableGroups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_requests(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_requests API.

Search My Requests

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyRequests

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12004

def list_my_requests(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_requests.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/MyRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MyRequests'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_smtp_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_smtp_credentials API.

Search for a user's own SMTP credential.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MySmtpCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12090

def list_my_smtp_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_smtp_credentials.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MySmtpCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_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: 'OCI::IdentityDomains::Models::MySmtpCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_support_accounts(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_support_accounts API.

Search for a user's own support account.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MySupportAccounts

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12164

def list_my_support_accounts(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_support_accounts.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MySupportAccounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_support_accounts') 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::IdentityDomains::Models::MySupportAccounts'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_trusted_user_agents(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_trusted_user_agents API.

Search Trusted User Agents

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyTrustedUserAgents

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12241

def list_my_trusted_user_agents(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_trusted_user_agents.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/MyTrustedUserAgents'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_trusted_user_agents') 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::IdentityDomains::Models::MyTrustedUserAgents'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_my_user_db_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_my_user_db_credentials API.

Search for a user's own database (DB) credential.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyUserDbCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12327

def list_my_user_db_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_my_user_db_credentials.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/MyUserDbCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_my_user_db_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: 'OCI::IdentityDomains::Models::MyUserDbCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_perimeters(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_perimeters API.

Search NetworkPerimeters

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type NetworkPerimeters

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12404

def list_network_perimeters(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_network_perimeters.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/NetworkPerimeters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_network_perimeters') 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::IdentityDomains::Models::NetworkPerimeters'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_notification_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_notification_settings API.

Search Notification Settings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type NotificationSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12488

def list_notification_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_notification_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/NotificationSettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_notification_settings') 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::IdentityDomains::Models::NotificationSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_o_auth2_client_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_o_auth2_client_credentials API.

Search for a user's OAuth2 client credentials.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type OAuth2ClientCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12568

def list_o_auth2_client_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_o_auth2_client_credentials.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/OAuth2ClientCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_o_auth2_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: 'OCI::IdentityDomains::Models::OAuth2ClientCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_o_auth_client_certificates(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_o_auth_client_certificates API.

Search OAuth Client Certificates

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type OAuthClientCertificates

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12654

def list_o_auth_client_certificates(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_o_auth_client_certificates.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/OAuthClientCertificates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_o_auth_client_certificates') 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::IdentityDomains::Models::OAuthClientCertificates'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_o_auth_partner_certificates(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_o_auth_partner_certificates API.

Search OAuth Partner Certificates

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type OAuthPartnerCertificates

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12728

def list_o_auth_partner_certificates(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_o_auth_partner_certificates.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/OAuthPartnerCertificates'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_o_auth_partner_certificates') 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::IdentityDomains::Models::OAuthPartnerCertificates'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_password_policies(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_password_policies API.

Search for password policies.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type PasswordPolicies

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12805

def list_password_policies(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_password_policies.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/PasswordPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_password_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: 'OCI::IdentityDomains::Models::PasswordPolicies'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_policies(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_policies API.

Search Policies

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Policies

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12894

def list_policies(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_policies.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Policies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::Policies'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_type_schema_attributes(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_resource_type_schema_attributes API.

Search Resource Type Schema Attributes

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ResourceTypeSchemaAttributes

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 12983

def list_resource_type_schema_attributes(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_resource_type_schema_attributes.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/ResourceTypeSchemaAttributes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_resource_type_schema_attributes') 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::IdentityDomains::Models::ResourceTypeSchemaAttributes'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_rules(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_rules API.

Search Rules

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Rules

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13072

def list_rules(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_rules.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Rules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_rules') 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::IdentityDomains::Models::Rules'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_schemas(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_schemas API.

Search Schemas

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Schemas

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13157

def list_schemas(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_schemas.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end

  path = '/admin/v1/Schemas'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_schemas') 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::IdentityDomains::Models::Schemas'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_question_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_question_settings API.

Search for security question settings.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SecurityQuestionSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13228

def list_security_question_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_security_question_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SecurityQuestionSettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_security_question_settings') 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::IdentityDomains::Models::SecurityQuestionSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_questions(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_questions API.

Search for security questions.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SecurityQuestions

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13308

def list_security_questions(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_security_questions.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SecurityQuestions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_security_questions') 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::IdentityDomains::Models::SecurityQuestions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_self_registration_profiles(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_self_registration_profiles API.

Search for self-registration profiles.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SelfRegistrationProfiles

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13397

def list_self_registration_profiles(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_self_registration_profiles.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SelfRegistrationProfiles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_self_registration_profiles') 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::IdentityDomains::Models::SelfRegistrationProfiles'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_settings API.

Search Settings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Settings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13481

def list_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Settings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_settings') 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::IdentityDomains::Models::Settings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_smtp_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_smtp_credentials API.

Search for SMTP credentials.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SmtpCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13561

def list_smtp_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_smtp_credentials.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/SmtpCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::SmtpCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_attributes_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_attributes_settings API.

Search User Schema Attribute Settings

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type UserAttributesSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13645

def list_user_attributes_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_user_attributes_settings.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/UserAttributesSettings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_user_attributes_settings') 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::IdentityDomains::Models::UserAttributesSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_user_db_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_user_db_credentials API.

Search for a user's database (DB) credentials.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type UserDbCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13725

def list_user_db_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_user_db_credentials.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/UserDbCredentials'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#list_user_db_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: 'OCI::IdentityDomains::Models::UserDbCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_users(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_users API.

Search for users.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :filter (String) —

  OPTIONAL. The filter string that is used to request a subset of resources. The filter string MUST be a valid filter expression. See the Filtering section of the SCIM specification for more information (Section 3.4.2.2). The string should contain at least one condition that each item must match in order to be returned in the search results. Each condition specifies an attribute, an operator, and a value. Conditions within a filter can be connected by logical operators (such as AND and OR). Sets of conditions can be grouped together using parentheses.

• :sort_by (String) —

  OPTIONAL. A string that indicates the attribute whose value SHALL be used to order the returned responses. The sortBy attribute MUST be in standard attribute notation form. See the Attribute Notation section of the SCIM specification for more information (Section 3.10). Also, see the Sorting section of the SCIM specification for more information (Section 3.4.2.3). (default to id)

• :sort_order (String) —

  A string that indicates the order in which the sortBy parameter is applied. Allowed values are 'ascending' and 'descending'. See (Sorting Section). OPTIONAL. (default to ASCENDING)

• :start_index (Integer) —

  OPTIONAL. An integer that indicates the 1-based index of the first query result. See the Pagination section of the SCIM specification for more information. (Section 3.4.2.4). The number of results pages to return. The first page is 1. Specify 2 to access the second page of results, and so on. (default to 1)

• :count (Integer) —

  OPTIONAL. An integer that indicates the desired maximum number of query results per page. 1000 is the largest value that you can use. See the Pagination section of the System for Cross-Domain Identity Management Protocol specification for more information. (Section 3.4.2.4). (default to 50)

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Users

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13814

def list_users(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#list_users.' if logger


  if opts[:sort_order] && !OCI::IdentityDomains::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::IdentityDomains::Models::SORT_ORDER_ENUM.'
  end


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Users'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:filter] = opts[:filter] if opts[:filter]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:startIndex] = opts[:start_index] if opts[:start_index]
  query_params[:count] = opts[:count] if opts[:count]
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#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: 'OCI::IdentityDomains::Models::Users'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

• (Logger) —

  The logger for this client. May be nil.

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 69

def logger
  @api_client.config.logger
end

#patch_account_recovery_setting(account_recovery_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_account_recovery_setting API.

Update an account recovery setting.

Parameters:

• account_recovery_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the AccountRecoverySettings with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AccountRecoverySetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 13912

def patch_account_recovery_setting(account_recovery_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_account_recovery_setting.' if logger

  raise "Missing the required parameter 'account_recovery_setting_id' when calling patch_account_recovery_setting." if account_recovery_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'account_recovery_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(account_recovery_setting_id)

  path = '/admin/v1/AccountRecoverySettings/{accountRecoverySettingId}'.sub('{accountRecoverySettingId}', account_recovery_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_account_recovery_setting') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::AccountRecoverySetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_api_key(api_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_api_key API.

Update a user's API key.

Parameters:

• api_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the ApiKey with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApiKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14002

def patch_api_key(api_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_api_key.' if logger

  raise "Missing the required parameter 'api_key_id' when calling patch_api_key." if api_key_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'api_key_id' must not be blank" if OCI::Internal::Util.blank_string?(api_key_id)

  path = '/admin/v1/ApiKeys/{apiKeyId}'.sub('{apiKeyId}', api_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_api_key') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_app(app_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_app API.

Update an App

Parameters:

• app_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the App with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type App

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14092

def patch_app(app_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_app.' if logger

  raise "Missing the required parameter 'app_id' when calling patch_app." if app_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'app_id' must not be blank" if OCI::Internal::Util.blank_string?(app_id)

  path = '/admin/v1/Apps/{appId}'.sub('{appId}', app_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_app') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::App'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_app_role(app_role_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_app_role API.

Update an AppRole

Parameters:

• app_role_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the AppRole with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AppRole

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14182

def patch_app_role(app_role_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_app_role.' if logger

  raise "Missing the required parameter 'app_role_id' when calling patch_app_role." if app_role_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'app_role_id' must not be blank" if OCI::Internal::Util.blank_string?(app_role_id)

  path = '/admin/v1/AppRoles/{appRoleId}'.sub('{appRoleId}', app_role_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_app_role') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::AppRole'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_approval_workflow API.

Update ApprovalWorkflow

Parameters:

• approval_workflow_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the ApprovalWorkflow with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflow

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14272

def patch_approval_workflow(approval_workflow_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_approval_workflow.' if logger

  raise "Missing the required parameter 'approval_workflow_id' when calling patch_approval_workflow." if approval_workflow_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'approval_workflow_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_id)

  path = '/admin/v1/ApprovalWorkflows/{approvalWorkflowId}'.sub('{approvalWorkflowId}', approval_workflow_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_approval_workflow') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::ApprovalWorkflow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_approval_workflow_step(approval_workflow_step_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_approval_workflow_step API.

Update ApprovalWorkflowStep

Parameters:

• approval_workflow_step_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the ApprovalWorkflowStep with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflowStep

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14362

def patch_approval_workflow_step(approval_workflow_step_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_approval_workflow_step.' if logger

  raise "Missing the required parameter 'approval_workflow_step_id' when calling patch_approval_workflow_step." if approval_workflow_step_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'approval_workflow_step_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_step_id)

  path = '/admin/v1/ApprovalWorkflowSteps/{approvalWorkflowStepId}'.sub('{approvalWorkflowStepId}', approval_workflow_step_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_approval_workflow_step') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::ApprovalWorkflowStep'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_auth_token(auth_token_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_auth_token API.

Update a user's Auth token.

Parameters:

• auth_token_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the AuthToken with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AuthToken

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14452

def patch_auth_token(auth_token_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_auth_token.' if logger

  raise "Missing the required parameter 'auth_token_id' when calling patch_auth_token." if auth_token_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(auth_token_id)

  path = '/admin/v1/AuthTokens/{authTokenId}'.sub('{authTokenId}', auth_token_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_auth_token') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::AuthToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_cloud_gate API.

Update a Cloud Gate

Parameters:

• cloud_gate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the CloudGate with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14542

def patch_cloud_gate(cloud_gate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_cloud_gate.' if logger

  raise "Missing the required parameter 'cloud_gate_id' when calling patch_cloud_gate." if cloud_gate_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_id)

  path = '/admin/v1/CloudGates/{cloudGateId}'.sub('{cloudGateId}', cloud_gate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_cloud_gate') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::CloudGate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_cloud_gate_mapping API.

Update a Cloud Gate mapping

Parameters:

• cloud_gate_mapping_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the CloudGateMapping with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateMapping

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14632

def patch_cloud_gate_mapping(cloud_gate_mapping_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_cloud_gate_mapping.' if logger

  raise "Missing the required parameter 'cloud_gate_mapping_id' when calling patch_cloud_gate_mapping." if cloud_gate_mapping_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_mapping_id)

  path = '/admin/v1/CloudGateMappings/{cloudGateMappingId}'.sub('{cloudGateMappingId}', cloud_gate_mapping_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_cloud_gate_mapping') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::CloudGateMapping'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_cloud_gate_server API.

Update a Cloud Gate server

Parameters:

• cloud_gate_server_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the CloudGateServer with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateServer

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14722

def patch_cloud_gate_server(cloud_gate_server_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_cloud_gate_server.' if logger

  raise "Missing the required parameter 'cloud_gate_server_id' when calling patch_cloud_gate_server." if cloud_gate_server_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_server_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_server_id)

  path = '/admin/v1/CloudGateServers/{cloudGateServerId}'.sub('{cloudGateServerId}', cloud_gate_server_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_cloud_gate_server') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::CloudGateServer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_condition(condition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_condition API.

Update a Condition

Parameters:

• condition_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Condition with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Condition

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14812

def patch_condition(condition_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_condition.' if logger

  raise "Missing the required parameter 'condition_id' when calling patch_condition." if condition_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'condition_id' must not be blank" if OCI::Internal::Util.blank_string?(condition_id)

  path = '/admin/v1/Conditions/{conditionId}'.sub('{conditionId}', condition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_condition') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Condition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_customer_secret_key(customer_secret_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_customer_secret_key API.

Update a user's customer secret key.

Parameters:

• customer_secret_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the CustomerSecretKey with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CustomerSecretKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14902

def patch_customer_secret_key(customer_secret_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_customer_secret_key.' if logger

  raise "Missing the required parameter 'customer_secret_key_id' when calling patch_customer_secret_key." if customer_secret_key_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(customer_secret_key_id)

  path = '/admin/v1/CustomerSecretKeys/{customerSecretKeyId}'.sub('{customerSecretKeyId}', customer_secret_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_customer_secret_key') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::CustomerSecretKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_dynamic_resource_group API.

Update a Dynamic Resource Group.

Parameters:

• dynamic_resource_group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the DynamicResourceGroup with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type DynamicResourceGroup

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 14992

def patch_dynamic_resource_group(dynamic_resource_group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_dynamic_resource_group.' if logger

  raise "Missing the required parameter 'dynamic_resource_group_id' when calling patch_dynamic_resource_group." if dynamic_resource_group_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'dynamic_resource_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_resource_group_id)

  path = '/admin/v1/DynamicResourceGroups/{dynamicResourceGroupId}'.sub('{dynamicResourceGroupId}', dynamic_resource_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_dynamic_resource_group') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::DynamicResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_grant(grant_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_grant API.

Update a Grant

Parameters:

• grant_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Grant with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Grant

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15082

def patch_grant(grant_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_grant.' if logger

  raise "Missing the required parameter 'grant_id' when calling patch_grant." if grant_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'grant_id' must not be blank" if OCI::Internal::Util.blank_string?(grant_id)

  path = '/admin/v1/Grants/{grantId}'.sub('{grantId}', grant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_grant') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Grant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_group(group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_group API.

Update a group.

Parameters:

• group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Group with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Group

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15172

def patch_group(group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_group.' if logger

  raise "Missing the required parameter 'group_id' when calling patch_group." if group_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'group_id' must not be blank" if OCI::Internal::Util.blank_string?(group_id)

  path = '/admin/v1/Groups/{groupId}'.sub('{groupId}', group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_group') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Group'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_identity_provider(identity_provider_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_identity_provider API.

Update an Identity Provider

Parameters:

• identity_provider_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the IdentityProvider with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentityProvider

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15262

def patch_identity_provider(identity_provider_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_identity_provider.' if logger

  raise "Missing the required parameter 'identity_provider_id' when calling patch_identity_provider." if identity_provider_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id)

  path = '/admin/v1/IdentityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_identity_provider') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::IdentityProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_identity_setting(identity_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_identity_setting API.

Update an Identity setting.

Parameters:

• identity_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the IdentitySettings with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentitySetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15352

def patch_identity_setting(identity_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_identity_setting.' if logger

  raise "Missing the required parameter 'identity_setting_id' when calling patch_identity_setting." if identity_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'identity_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_setting_id)

  path = '/admin/v1/IdentitySettings/{identitySettingId}'.sub('{identitySettingId}', identity_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_identity_setting') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::IdentitySetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_kmsi_setting(kmsi_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_kmsi_setting API.

Update a Setting

Parameters:

• kmsi_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the KmsiSettings with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type KmsiSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15442

def patch_kmsi_setting(kmsi_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_kmsi_setting.' if logger

  raise "Missing the required parameter 'kmsi_setting_id' when calling patch_kmsi_setting." if kmsi_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'kmsi_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(kmsi_setting_id)

  path = '/admin/v1/KmsiSettings/{kmsiSettingId}'.sub('{kmsiSettingId}', kmsi_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_kmsi_setting') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::KmsiSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_me(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_me API.

Update a user's own information.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Me with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Me

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15531

def patch_me(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_me.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Me'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_me') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Me'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_api_key(my_api_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_api_key API.

Update a user's own API key.

Parameters:

• my_api_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyApiKey with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyApiKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15616

def patch_my_api_key(my_api_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_api_key.' if logger

  raise "Missing the required parameter 'my_api_key_id' when calling patch_my_api_key." if my_api_key_id.nil?
  raise "Parameter value for 'my_api_key_id' must not be blank" if OCI::Internal::Util.blank_string?(my_api_key_id)

  path = '/admin/v1/MyApiKeys/{myApiKeyId}'.sub('{myApiKeyId}', my_api_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_api_key') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_auth_token(my_auth_token_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_auth_token API.

Update a user's own Auth token.

Parameters:

• my_auth_token_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyAuthToken with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyAuthToken

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15691

def patch_my_auth_token(my_auth_token_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_auth_token.' if logger

  raise "Missing the required parameter 'my_auth_token_id' when calling patch_my_auth_token." if my_auth_token_id.nil?
  raise "Parameter value for 'my_auth_token_id' must not be blank" if OCI::Internal::Util.blank_string?(my_auth_token_id)

  path = '/admin/v1/MyAuthTokens/{myAuthTokenId}'.sub('{myAuthTokenId}', my_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_auth_token') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyAuthToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_customer_secret_key(my_customer_secret_key_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_customer_secret_key API.

Update a user's own customer secret key.

Parameters:

• my_customer_secret_key_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyCustomerSecretKey with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyCustomerSecretKey

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15766

def patch_my_customer_secret_key(my_customer_secret_key_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_customer_secret_key.' if logger

  raise "Missing the required parameter 'my_customer_secret_key_id' when calling patch_my_customer_secret_key." if my_customer_secret_key_id.nil?
  raise "Parameter value for 'my_customer_secret_key_id' must not be blank" if OCI::Internal::Util.blank_string?(my_customer_secret_key_id)

  path = '/admin/v1/MyCustomerSecretKeys/{myCustomerSecretKeyId}'.sub('{myCustomerSecretKeyId}', my_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_customer_secret_key') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyCustomerSecretKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_device(my_device_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_device API.

Update a Device

Parameters:

• my_device_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyDevice with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyDevice

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15844

def patch_my_device(my_device_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_device.' if logger

  raise "Missing the required parameter 'my_device_id' when calling patch_my_device." if my_device_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'my_device_id' must not be blank" if OCI::Internal::Util.blank_string?(my_device_id)

  path = '/admin/v1/MyDevices/{myDeviceId}'.sub('{myDeviceId}', my_device_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_device') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyDevice'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_o_auth2_client_credential API.

Update a user's own OAuth2 client credential.

Parameters:

• my_o_auth2_client_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyOAuth2ClientCredential with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyOAuth2ClientCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 15931

def patch_my_o_auth2_client_credential(my_o_auth2_client_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_o_auth2_client_credential.' if logger

  raise "Missing the required parameter 'my_o_auth2_client_credential_id' when calling patch_my_o_auth2_client_credential." if my_o_auth2_client_credential_id.nil?
  raise "Parameter value for 'my_o_auth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_o_auth2_client_credential_id)

  path = '/admin/v1/MyOAuth2ClientCredentials/{myOAuth2ClientCredentialId}'.sub('{myOAuth2ClientCredentialId}', my_o_auth2_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_o_auth2_client_credential') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyOAuth2ClientCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_pending_approval(my_pending_approval_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_pending_approval API.

Update MyPendingApproval

Parameters:

• my_pending_approval_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyPendingApproval with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyPendingApproval

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16006

def patch_my_pending_approval(my_pending_approval_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_pending_approval.' if logger

  raise "Missing the required parameter 'my_pending_approval_id' when calling patch_my_pending_approval." if my_pending_approval_id.nil?
  raise "Parameter value for 'my_pending_approval_id' must not be blank" if OCI::Internal::Util.blank_string?(my_pending_approval_id)

  path = '/admin/v1/MyPendingApprovals/{myPendingApprovalId}'.sub('{myPendingApprovalId}', my_pending_approval_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_pending_approval') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyPendingApproval'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_request(my_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_request API.

Update My Requests

Parameters:

• my_request_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MyRequest with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MyRequest

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16084

def patch_my_request(my_request_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_request.' if logger

  raise "Missing the required parameter 'my_request_id' when calling patch_my_request." if my_request_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'my_request_id' must not be blank" if OCI::Internal::Util.blank_string?(my_request_id)

  path = '/admin/v1/MyRequests/{myRequestId}'.sub('{myRequestId}', my_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_request') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MyRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_my_smtp_credential(my_smtp_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_my_smtp_credential API.

Update a user's own SMTP credential.

Parameters:

• my_smtp_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the MySmtpCredential with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MySmtpCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16171

def patch_my_smtp_credential(my_smtp_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_my_smtp_credential.' if logger

  raise "Missing the required parameter 'my_smtp_credential_id' when calling patch_my_smtp_credential." if my_smtp_credential_id.nil?
  raise "Parameter value for 'my_smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(my_smtp_credential_id)

  path = '/admin/v1/MySmtpCredentials/{mySmtpCredentialId}'.sub('{mySmtpCredentialId}', my_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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_my_smtp_credential') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::MySmtpCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_network_perimeter API.

Update a NetworkPerimeter

Parameters:

• network_perimeter_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the NetworkPerimeter with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type NetworkPerimeter

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16249

def patch_network_perimeter(network_perimeter_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_network_perimeter.' if logger

  raise "Missing the required parameter 'network_perimeter_id' when calling patch_network_perimeter." if network_perimeter_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'network_perimeter_id' must not be blank" if OCI::Internal::Util.blank_string?(network_perimeter_id)

  path = '/admin/v1/NetworkPerimeters/{networkPerimeterId}'.sub('{networkPerimeterId}', network_perimeter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_network_perimeter') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::NetworkPerimeter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_o_auth2_client_credential(o_auth2_client_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_o_auth2_client_credential API.

Update a user's OAuth2 client credentials.

Parameters:

• o_auth2_client_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the OAuth2ClientCredential with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type OAuth2ClientCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16339

def patch_o_auth2_client_credential(o_auth2_client_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_o_auth2_client_credential.' if logger

  raise "Missing the required parameter 'o_auth2_client_credential_id' when calling patch_o_auth2_client_credential." if o_auth2_client_credential_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'o_auth2_client_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(o_auth2_client_credential_id)

  path = '/admin/v1/OAuth2ClientCredentials/{oAuth2ClientCredentialId}'.sub('{oAuth2ClientCredentialId}', o_auth2_client_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_o_auth2_client_credential') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::OAuth2ClientCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_password_policy(password_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_password_policy API.

Update a password policy.

Parameters:

• password_policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the PasswordPolicy with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type PasswordPolicy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16429

def patch_password_policy(password_policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_password_policy.' if logger

  raise "Missing the required parameter 'password_policy_id' when calling patch_password_policy." if password_policy_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'password_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(password_policy_id)

  path = '/admin/v1/PasswordPolicies/{passwordPolicyId}'.sub('{passwordPolicyId}', password_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_password_policy') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::PasswordPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_policy(policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_policy API.

Update a Policy

Parameters:

• policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Policy with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Policy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16519

def patch_policy(policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_policy.' if logger

  raise "Missing the required parameter 'policy_id' when calling patch_policy." if policy_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'policy_id' must not be blank" if OCI::Internal::Util.blank_string?(policy_id)

  path = '/admin/v1/Policies/{policyId}'.sub('{policyId}', policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_policy') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Policy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_rule(rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_rule API.

Update a Rule

Parameters:

• rule_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Rule with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Rule

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16609

def patch_rule(rule_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_rule.' if logger

  raise "Missing the required parameter 'rule_id' when calling patch_rule." if rule_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id)

  path = '/admin/v1/Rules/{ruleId}'.sub('{ruleId}', rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_rule') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Rule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_schema(schema_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_schema API.

Update a Schema Def

Parameters:

• schema_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Schema with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Schema

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16696

def patch_schema(schema_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_schema.' if logger

  raise "Missing the required parameter 'schema_id' when calling patch_schema." if schema_id.nil?
  raise "Parameter value for 'schema_id' must not be blank" if OCI::Internal::Util.blank_string?(schema_id)

  path = '/admin/v1/Schemas/{schemaId}'.sub('{schemaId}', schema_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_schema') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Schema'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_security_question(security_question_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_security_question API.

Update a security question.

Parameters:

• security_question_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the SecurityQuestion with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SecurityQuestion

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16774

def patch_security_question(security_question_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_security_question.' if logger

  raise "Missing the required parameter 'security_question_id' when calling patch_security_question." if security_question_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'security_question_id' must not be blank" if OCI::Internal::Util.blank_string?(security_question_id)

  path = '/admin/v1/SecurityQuestions/{securityQuestionId}'.sub('{securityQuestionId}', security_question_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_security_question') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::SecurityQuestion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_security_question_setting(security_question_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_security_question_setting API.

Update a security question setting.

Parameters:

• security_question_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the SecurityQuestionSettings with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SecurityQuestionSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16864

def patch_security_question_setting(security_question_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_security_question_setting.' if logger

  raise "Missing the required parameter 'security_question_setting_id' when calling patch_security_question_setting." if security_question_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'security_question_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(security_question_setting_id)

  path = '/admin/v1/SecurityQuestionSettings/{securityQuestionSettingId}'.sub('{securityQuestionSettingId}', security_question_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_security_question_setting') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::SecurityQuestionSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_self_registration_profile API.

Update a self-registration profile.

Parameters:

• self_registration_profile_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the SelfRegistrationProfile with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SelfRegistrationProfile

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 16954

def patch_self_registration_profile(self_registration_profile_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_self_registration_profile.' if logger

  raise "Missing the required parameter 'self_registration_profile_id' when calling patch_self_registration_profile." if self_registration_profile_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'self_registration_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(self_registration_profile_id)

  path = '/admin/v1/SelfRegistrationProfiles/{selfRegistrationProfileId}'.sub('{selfRegistrationProfileId}', self_registration_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_self_registration_profile') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::SelfRegistrationProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_setting(setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_setting API.

Update a Setting

Parameters:

• setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the Settings with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Setting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17044

def patch_setting(setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_setting.' if logger

  raise "Missing the required parameter 'setting_id' when calling patch_setting." if setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'setting_id' must not be blank" if OCI::Internal::Util.blank_string?(setting_id)

  path = '/admin/v1/Settings/{settingId}'.sub('{settingId}', setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_setting') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::Setting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_smtp_credential(smtp_credential_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_smtp_credential API.

Update a user's SMTP credentials.

Parameters:

• smtp_credential_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the SmtpCredential with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SmtpCredential

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17134

def patch_smtp_credential(smtp_credential_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_smtp_credential.' if logger

  raise "Missing the required parameter 'smtp_credential_id' when calling patch_smtp_credential." if smtp_credential_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'smtp_credential_id' must not be blank" if OCI::Internal::Util.blank_string?(smtp_credential_id)

  path = '/admin/v1/SmtpCredentials/{smtpCredentialId}'.sub('{smtpCredentialId}', smtp_credential_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_smtp_credential') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::SmtpCredential'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_user(user_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_user API.

Update a user.

Parameters:

• user_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the User with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type User

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17224

def patch_user(user_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_user.' if logger

  raise "Missing the required parameter 'user_id' when calling patch_user." if user_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id)

  path = '/admin/v1/Users/{userId}'.sub('{userId}', user_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_user') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::User'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_user_attributes_setting(user_attributes_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_user_attributes_setting API.

Update User Schema Attribute Settings

Parameters:

• user_attributes_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :patch_op (OCI::IdentityDomains::Models::PatchOp) —

  Update the UserAttributesSettings with SCIM Patch schema.

  Before you specify an attribute-value in a request to update a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserAttributesSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17314

def patch_user_attributes_setting(user_attributes_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#patch_user_attributes_setting.' if logger

  raise "Missing the required parameter 'user_attributes_setting_id' when calling patch_user_attributes_setting." if user_attributes_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_attributes_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(user_attributes_setting_id)

  path = '/admin/v1/UserAttributesSettings/{userAttributesSettingId}'.sub('{userAttributesSettingId}', user_attributes_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:patch_op])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#patch_user_attributes_setting') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::IdentityDomains::Models::UserAttributesSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_account_recovery_setting(account_recovery_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_account_recovery_setting API.

Replace an account recovery setting.

Parameters:

• account_recovery_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :account_recovery_setting (OCI::IdentityDomains::Models::AccountRecoverySetting) —

  Replace the current instance of AccountRecoverySettings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AccountRecoverySetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17404

def put_account_recovery_setting(account_recovery_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_account_recovery_setting.' if logger

  raise "Missing the required parameter 'account_recovery_setting_id' when calling put_account_recovery_setting." if account_recovery_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'account_recovery_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(account_recovery_setting_id)

  path = '/admin/v1/AccountRecoverySettings/{accountRecoverySettingId}'.sub('{accountRecoverySettingId}', account_recovery_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:account_recovery_setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_account_recovery_setting') 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::IdentityDomains::Models::AccountRecoverySetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_app(app_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_app API.

Replace an App

Parameters:

• app_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :app (OCI::IdentityDomains::Models::App) —

  Replace the current instance of App with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type App

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17494

def put_app(app_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_app.' if logger

  raise "Missing the required parameter 'app_id' when calling put_app." if app_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'app_id' must not be blank" if OCI::Internal::Util.blank_string?(app_id)

  path = '/admin/v1/Apps/{appId}'.sub('{appId}', app_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:app])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_app') 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::IdentityDomains::Models::App'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_app_status_changer(app_status_changer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_app_status_changer API.

Activate/Deactivate an App

Parameters:

• app_status_changer_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :app_status_changer (OCI::IdentityDomains::Models::AppStatusChanger) —

  Replace the current instance of AppStatusChanger with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AppStatusChanger

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17584

def put_app_status_changer(app_status_changer_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_app_status_changer.' if logger

  raise "Missing the required parameter 'app_status_changer_id' when calling put_app_status_changer." if app_status_changer_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'app_status_changer_id' must not be blank" if OCI::Internal::Util.blank_string?(app_status_changer_id)

  path = '/admin/v1/AppStatusChanger/{appStatusChangerId}'.sub('{appStatusChangerId}', app_status_changer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:app_status_changer])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_app_status_changer') 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::IdentityDomains::Models::AppStatusChanger'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_approval_workflow(approval_workflow_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_approval_workflow API.

Replace ApprovalWorkflow

Parameters:

• approval_workflow_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :approval_workflow (OCI::IdentityDomains::Models::ApprovalWorkflow) —

  Replace the current instance of ApprovalWorkflow with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type ApprovalWorkflow

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17674

def put_approval_workflow(approval_workflow_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_approval_workflow.' if logger

  raise "Missing the required parameter 'approval_workflow_id' when calling put_approval_workflow." if approval_workflow_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'approval_workflow_id' must not be blank" if OCI::Internal::Util.blank_string?(approval_workflow_id)

  path = '/admin/v1/ApprovalWorkflows/{approvalWorkflowId}'.sub('{approvalWorkflowId}', approval_workflow_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:approval_workflow])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_approval_workflow') 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::IdentityDomains::Models::ApprovalWorkflow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_authentication_factor_setting(authentication_factor_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_authentication_factor_setting API.

Replace Authentication Factor Settings

Parameters:

• authentication_factor_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :authentication_factor_setting (OCI::IdentityDomains::Models::AuthenticationFactorSetting) —

  Replace the current instance of AuthenticationFactorSettings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type AuthenticationFactorSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17764

def put_authentication_factor_setting(authentication_factor_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_authentication_factor_setting.' if logger

  raise "Missing the required parameter 'authentication_factor_setting_id' when calling put_authentication_factor_setting." if authentication_factor_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'authentication_factor_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_factor_setting_id)

  path = '/admin/v1/AuthenticationFactorSettings/{authenticationFactorSettingId}'.sub('{authenticationFactorSettingId}', authentication_factor_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:authentication_factor_setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_authentication_factor_setting') 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::IdentityDomains::Models::AuthenticationFactorSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_cloud_gate(cloud_gate_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_cloud_gate API.

Replace a Cloud Gate

Parameters:

• cloud_gate_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :cloud_gate (OCI::IdentityDomains::Models::CloudGate) —

  Replace the current instance of CloudGate with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGate

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17854

def put_cloud_gate(cloud_gate_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_cloud_gate.' if logger

  raise "Missing the required parameter 'cloud_gate_id' when calling put_cloud_gate." if cloud_gate_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_id)

  path = '/admin/v1/CloudGates/{cloudGateId}'.sub('{cloudGateId}', cloud_gate_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_cloud_gate') 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::IdentityDomains::Models::CloudGate'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_cloud_gate_mapping(cloud_gate_mapping_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_cloud_gate_mapping API.

Replace a Cloud Gate mapping

Parameters:

• cloud_gate_mapping_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :cloud_gate_mapping (OCI::IdentityDomains::Models::CloudGateMapping) —

  Replace the current instance of CloudGateMapping with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateMapping

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 17944

def put_cloud_gate_mapping(cloud_gate_mapping_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_cloud_gate_mapping.' if logger

  raise "Missing the required parameter 'cloud_gate_mapping_id' when calling put_cloud_gate_mapping." if cloud_gate_mapping_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_mapping_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_mapping_id)

  path = '/admin/v1/CloudGateMappings/{cloudGateMappingId}'.sub('{cloudGateMappingId}', cloud_gate_mapping_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_mapping])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_cloud_gate_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::IdentityDomains::Models::CloudGateMapping'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_cloud_gate_server(cloud_gate_server_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_cloud_gate_server API.

Replace a Cloud Gate server

Parameters:

• cloud_gate_server_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :cloud_gate_server (OCI::IdentityDomains::Models::CloudGateServer) —

  Replace the current instance of CloudGateServer with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type CloudGateServer

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18034

def put_cloud_gate_server(cloud_gate_server_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_cloud_gate_server.' if logger

  raise "Missing the required parameter 'cloud_gate_server_id' when calling put_cloud_gate_server." if cloud_gate_server_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'cloud_gate_server_id' must not be blank" if OCI::Internal::Util.blank_string?(cloud_gate_server_id)

  path = '/admin/v1/CloudGateServers/{cloudGateServerId}'.sub('{cloudGateServerId}', cloud_gate_server_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_server])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_cloud_gate_server') 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::IdentityDomains::Models::CloudGateServer'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_condition(condition_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_condition API.

Replace a Condition

Parameters:

• condition_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :condition (OCI::IdentityDomains::Models::Condition) —

  Replace the current instance of Condition with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Condition

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18124

def put_condition(condition_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_condition.' if logger

  raise "Missing the required parameter 'condition_id' when calling put_condition." if condition_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'condition_id' must not be blank" if OCI::Internal::Util.blank_string?(condition_id)

  path = '/admin/v1/Conditions/{conditionId}'.sub('{conditionId}', condition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:condition])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_condition') 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::IdentityDomains::Models::Condition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_dynamic_resource_group(dynamic_resource_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_dynamic_resource_group API.

Replace a Dynamic Resource Group.

Parameters:

• dynamic_resource_group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :dynamic_resource_group (OCI::IdentityDomains::Models::DynamicResourceGroup) —

  Replace the current instance of DynamicResourceGroup with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type DynamicResourceGroup

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18214

def put_dynamic_resource_group(dynamic_resource_group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_dynamic_resource_group.' if logger

  raise "Missing the required parameter 'dynamic_resource_group_id' when calling put_dynamic_resource_group." if dynamic_resource_group_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'dynamic_resource_group_id' must not be blank" if OCI::Internal::Util.blank_string?(dynamic_resource_group_id)

  path = '/admin/v1/DynamicResourceGroups/{dynamicResourceGroupId}'.sub('{dynamicResourceGroupId}', dynamic_resource_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:dynamic_resource_group])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_dynamic_resource_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::IdentityDomains::Models::DynamicResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_group(group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_group API.

Replace a group.

Parameters:

• group_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :group (OCI::IdentityDomains::Models::Group) —

  Replace the current instance of Group with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Group

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18304

def put_group(group_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_group.' if logger

  raise "Missing the required parameter 'group_id' when calling put_group." if group_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'group_id' must not be blank" if OCI::Internal::Util.blank_string?(group_id)

  path = '/admin/v1/Groups/{groupId}'.sub('{groupId}', group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:group])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_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::IdentityDomains::Models::Group'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_identity_provider(identity_provider_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_identity_provider API.

Replace an Identity Provider

Parameters:

• identity_provider_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :identity_provider (OCI::IdentityDomains::Models::IdentityProvider) —

  Replace the current instance of IdentityProvider with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentityProvider

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18394

def put_identity_provider(identity_provider_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_identity_provider.' if logger

  raise "Missing the required parameter 'identity_provider_id' when calling put_identity_provider." if identity_provider_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'identity_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_provider_id)

  path = '/admin/v1/IdentityProviders/{identityProviderId}'.sub('{identityProviderId}', identity_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:identity_provider])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_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::IdentityDomains::Models::IdentityProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_identity_setting(identity_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_identity_setting API.

Replace an Identity setting.

Parameters:

• identity_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :identity_setting (OCI::IdentityDomains::Models::IdentitySetting) —

  Replace the current instance of IdentitySettings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type IdentitySetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18484

def put_identity_setting(identity_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_identity_setting.' if logger

  raise "Missing the required parameter 'identity_setting_id' when calling put_identity_setting." if identity_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'identity_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(identity_setting_id)

  path = '/admin/v1/IdentitySettings/{identitySettingId}'.sub('{identitySettingId}', identity_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:identity_setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_identity_setting') 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::IdentityDomains::Models::IdentitySetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_kmsi_setting(kmsi_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_kmsi_setting API.

Replace KmsiSettings

Parameters:

• kmsi_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :kmsi_setting (OCI::IdentityDomains::Models::KmsiSetting) —

  Replace the current instance of KmsiSettings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type KmsiSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18574

def put_kmsi_setting(kmsi_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_kmsi_setting.' if logger

  raise "Missing the required parameter 'kmsi_setting_id' when calling put_kmsi_setting." if kmsi_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'kmsi_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(kmsi_setting_id)

  path = '/admin/v1/KmsiSettings/{kmsiSettingId}'.sub('{kmsiSettingId}', kmsi_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:kmsi_setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_kmsi_setting') 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::IdentityDomains::Models::KmsiSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_me(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_me API.

Replace a user's own information.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :me (OCI::IdentityDomains::Models::Me) —

  Replace the current instance of Me with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Me

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18663

def put_me(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_me.' if logger



  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end

  path = '/admin/v1/Me'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:me])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_me') 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::IdentityDomains::Models::Me'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_me_password_changer(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_me_password_changer API.

Update a user's own password.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :me_password_changer (OCI::IdentityDomains::Models::MePasswordChanger) —

  Replace the current instance of MePasswordChanger with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type MePasswordChanger

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18747

def put_me_password_changer(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_me_password_changer.' if logger


  path = '/admin/v1/MePasswordChanger'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:me_password_changer])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_me_password_changer') 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::IdentityDomains::Models::MePasswordChanger'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_network_perimeter(network_perimeter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_network_perimeter API.

Replace a NetworkPerimeter

Parameters:

• network_perimeter_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :network_perimeter (OCI::IdentityDomains::Models::NetworkPerimeter) —

  Replace the current instance of NetworkPerimeter with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type NetworkPerimeter

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18823

def put_network_perimeter(network_perimeter_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_network_perimeter.' if logger

  raise "Missing the required parameter 'network_perimeter_id' when calling put_network_perimeter." if network_perimeter_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'network_perimeter_id' must not be blank" if OCI::Internal::Util.blank_string?(network_perimeter_id)

  path = '/admin/v1/NetworkPerimeters/{networkPerimeterId}'.sub('{networkPerimeterId}', network_perimeter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:network_perimeter])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_network_perimeter') 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::IdentityDomains::Models::NetworkPerimeter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_notification_setting(notification_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_notification_setting API.

Replace Notification Settings

Parameters:

• notification_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :notification_setting (OCI::IdentityDomains::Models::NotificationSetting) —

  Replace the current instance of NotificationSettings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type NotificationSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 18913

def put_notification_setting(notification_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_notification_setting.' if logger

  raise "Missing the required parameter 'notification_setting_id' when calling put_notification_setting." if notification_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'notification_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(notification_setting_id)

  path = '/admin/v1/NotificationSettings/{notificationSettingId}'.sub('{notificationSettingId}', notification_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:notification_setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_notification_setting') 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::IdentityDomains::Models::NotificationSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_password_policy(password_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_password_policy API.

Replace a password policy.

Parameters:

• password_policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :password_policy (OCI::IdentityDomains::Models::PasswordPolicy) —

  Replace the current instance of PasswordPolicy with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type PasswordPolicy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19003

def put_password_policy(password_policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_password_policy.' if logger

  raise "Missing the required parameter 'password_policy_id' when calling put_password_policy." if password_policy_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'password_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(password_policy_id)

  path = '/admin/v1/PasswordPolicies/{passwordPolicyId}'.sub('{passwordPolicyId}', password_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:password_policy])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_password_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::IdentityDomains::Models::PasswordPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_policy(policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_policy API.

Replace a Policy

Parameters:

• policy_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :policy (OCI::IdentityDomains::Models::Policy) —

  Replace the current instance of Policy with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Policy

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19093

def put_policy(policy_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_policy.' if logger

  raise "Missing the required parameter 'policy_id' when calling put_policy." if policy_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'policy_id' must not be blank" if OCI::Internal::Util.blank_string?(policy_id)

  path = '/admin/v1/Policies/{policyId}'.sub('{policyId}', policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:policy])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_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::IdentityDomains::Models::Policy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_rule(rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_rule API.

Replace a Rule

Parameters:

• rule_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :rule (OCI::IdentityDomains::Models::Rule) —

  Replace the current instance of Rule with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Rule

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19183

def put_rule(rule_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_rule.' if logger

  raise "Missing the required parameter 'rule_id' when calling put_rule." if rule_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id)

  path = '/admin/v1/Rules/{ruleId}'.sub('{ruleId}', rule_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:rule])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_rule') 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::IdentityDomains::Models::Rule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_schema(schema_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_schema API.

Replace a Schema Def

Parameters:

• schema_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :schema (OCI::IdentityDomains::Models::Schema) —

  Replace the current instance of Schema with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Schema

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19270

def put_schema(schema_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_schema.' if logger

  raise "Missing the required parameter 'schema_id' when calling put_schema." if schema_id.nil?
  raise "Parameter value for 'schema_id' must not be blank" if OCI::Internal::Util.blank_string?(schema_id)

  path = '/admin/v1/Schemas/{schemaId}'.sub('{schemaId}', schema_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:schema])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_schema') 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::IdentityDomains::Models::Schema'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_security_question_setting(security_question_setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_security_question_setting API.

Replace a security question setting.

Parameters:

• security_question_setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :security_question_setting (OCI::IdentityDomains::Models::SecurityQuestionSetting) —

  Replace the current instance of SecurityQuestionSettings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SecurityQuestionSetting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19348

def put_security_question_setting(security_question_setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_security_question_setting.' if logger

  raise "Missing the required parameter 'security_question_setting_id' when calling put_security_question_setting." if security_question_setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'security_question_setting_id' must not be blank" if OCI::Internal::Util.blank_string?(security_question_setting_id)

  path = '/admin/v1/SecurityQuestionSettings/{securityQuestionSettingId}'.sub('{securityQuestionSettingId}', security_question_setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:security_question_setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_security_question_setting') 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::IdentityDomains::Models::SecurityQuestionSetting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_self_registration_profile(self_registration_profile_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_self_registration_profile API.

Replace a self-registration profile.

Parameters:

• self_registration_profile_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :self_registration_profile (OCI::IdentityDomains::Models::SelfRegistrationProfile) —

  Replace the current instance of SelfRegistrationProfile with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type SelfRegistrationProfile

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19438

def put_self_registration_profile(self_registration_profile_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_self_registration_profile.' if logger

  raise "Missing the required parameter 'self_registration_profile_id' when calling put_self_registration_profile." if self_registration_profile_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'self_registration_profile_id' must not be blank" if OCI::Internal::Util.blank_string?(self_registration_profile_id)

  path = '/admin/v1/SelfRegistrationProfiles/{selfRegistrationProfileId}'.sub('{selfRegistrationProfileId}', self_registration_profile_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:self_registration_profile])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_self_registration_profile') 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::IdentityDomains::Models::SelfRegistrationProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_setting(setting_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_setting API.

Replace Settings

Parameters:

• setting_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :setting (OCI::IdentityDomains::Models::Setting) —

  Replace the current instance of Settings with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type Setting

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19528

def put_setting(setting_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_setting.' if logger

  raise "Missing the required parameter 'setting_id' when calling put_setting." if setting_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'setting_id' must not be blank" if OCI::Internal::Util.blank_string?(setting_id)

  path = '/admin/v1/Settings/{settingId}'.sub('{settingId}', setting_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:setting])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_setting') 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::IdentityDomains::Models::Setting'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_user(user_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_user API.

Replace a user.

Parameters:

• user_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :user (OCI::IdentityDomains::Models::User) —

  Replace the current instance of User with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type User

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19618

def put_user(user_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_user.' if logger

  raise "Missing the required parameter 'user_id' when calling put_user." if user_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_id' must not be blank" if OCI::Internal::Util.blank_string?(user_id)

  path = '/admin/v1/Users/{userId}'.sub('{userId}', user_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_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::IdentityDomains::Models::User'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_user_capabilities_changer(user_capabilities_changer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_user_capabilities_changer API.

Change a user's capabilities.

Parameters:

• user_capabilities_changer_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :user_capabilities_changer (OCI::IdentityDomains::Models::UserCapabilitiesChanger) —

  Replace the current instance of UserCapabilitiesChanger with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserCapabilitiesChanger

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19705

def put_user_capabilities_changer(user_capabilities_changer_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_user_capabilities_changer.' if logger

  raise "Missing the required parameter 'user_capabilities_changer_id' when calling put_user_capabilities_changer." if user_capabilities_changer_id.nil?
  raise "Parameter value for 'user_capabilities_changer_id' must not be blank" if OCI::Internal::Util.blank_string?(user_capabilities_changer_id)

  path = '/admin/v1/UserCapabilitiesChanger/{userCapabilitiesChangerId}'.sub('{userCapabilitiesChangerId}', user_capabilities_changer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_capabilities_changer])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_user_capabilities_changer') 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::IdentityDomains::Models::UserCapabilitiesChanger'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_user_password_changer(user_password_changer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_user_password_changer API.

Change a user's password to a known value.

Parameters:

• user_password_changer_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :user_password_changer (OCI::IdentityDomains::Models::UserPasswordChanger) —

  Replace the current instance of UserPasswordChanger with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserPasswordChanger

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19780

def put_user_password_changer(user_password_changer_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_user_password_changer.' if logger

  raise "Missing the required parameter 'user_password_changer_id' when calling put_user_password_changer." if user_password_changer_id.nil?
  raise "Parameter value for 'user_password_changer_id' must not be blank" if OCI::Internal::Util.blank_string?(user_password_changer_id)

  path = '/admin/v1/UserPasswordChanger/{userPasswordChangerId}'.sub('{userPasswordChangerId}', user_password_changer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_password_changer])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_user_password_changer') 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::IdentityDomains::Models::UserPasswordChanger'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_user_password_resetter(user_password_resetter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_user_password_resetter API.

Reset a user's password to a randomly-generated value.

Parameters:

• user_password_resetter_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :user_password_resetter (OCI::IdentityDomains::Models::UserPasswordResetter) —

  Replace the current instance of UserPasswordResetter with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserPasswordResetter

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19855

def put_user_password_resetter(user_password_resetter_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_user_password_resetter.' if logger

  raise "Missing the required parameter 'user_password_resetter_id' when calling put_user_password_resetter." if user_password_resetter_id.nil?
  raise "Parameter value for 'user_password_resetter_id' must not be blank" if OCI::Internal::Util.blank_string?(user_password_resetter_id)

  path = '/admin/v1/UserPasswordResetter/{userPasswordResetterId}'.sub('{userPasswordResetterId}', user_password_resetter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_password_resetter])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_user_password_resetter') 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::IdentityDomains::Models::UserPasswordResetter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#put_user_status_changer(user_status_changer_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use put_user_status_changer API.

Change a user's status.

Parameters:

• user_status_changer_id (String) —

  ID of the resource

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :attributes (String) —

  A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always.

• :attribute_sets (Array<String>) —

  A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. Allowed values are: all, always, never, request, default

• :user_status_changer (OCI::IdentityDomains::Models::UserStatusChanger) —

  Replace the current instance of UserStatusChanger with provided payload.

  Before you specify an attribute-value in a request to replace a resource, please check the 'mutability' property of that attribute in the resource-type schema below. Clicking on an attribute-row will expand that row to show the SCIM++ Properties of that attribute. - Your request to create, update or replace a resource may specify in its payload a value for any attribute that is defined as mutability:readWrite or mutability:writeOnly or mutability:immutable: - The SCIM APIs to create a resource will ignore silently any value that you specify for an attribute that is defined as mutability:readOnly. - The SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify a value for an attribute that is defined as mutability:readOnly. - Similarly, the SCIM APIs to update or replace a resource will fail with an error 400 Bad Request if you specify any value for an attribute that is defined as mutability:immutable and that already has a value in the specified resource.

  Also, before you use the query-parameter attributes to request specific attributes, please check the 'returned' property of that attribute in the resource-type schema below: - Your request to read a resource (or to search a resource-type) can specify as the value of attributes any attributes that are defined as returned:default or returned:request or returned:always: - If you request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the set of attributes that you requested, as well as any attribute that is defined as returned:always. - If you do not request a specific set of attributes, the SCIM APIs to read a resource (or to search a resource-type) will return in each resource the the set of attributes defined as returned:default, as well as any attribute that is defined as returned:always. - The SCIM APIs to read a resource (or to search a resource-type) will ignore silently any request to return an attribute that is defined as returned:never.

• :if_match (String) —

  Used to make the request conditional on an ETag

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

Returns:

• (Response) —

  A Response object with data of type UserStatusChanger

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 19933

def put_user_status_changer(user_status_changer_id, opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#put_user_status_changer.' if logger

  raise "Missing the required parameter 'user_status_changer_id' when calling put_user_status_changer." if user_status_changer_id.nil?


  attribute_sets_allowable_values = %w[all always never request default]
  if opts[:attribute_sets] && !opts[:attribute_sets].empty?
    opts[:attribute_sets].each do |val_to_check|
      unless attribute_sets_allowable_values.include?(val_to_check)
        raise 'Invalid value for "attribute_sets", must be one of all, always, never, request, default.'
      end
    end
  end
  raise "Parameter value for 'user_status_changer_id' must not be blank" if OCI::Internal::Util.blank_string?(user_status_changer_id)

  path = '/admin/v1/UserStatusChanger/{userStatusChangerId}'.sub('{userStatusChangerId}', user_status_changer_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:attributes] = opts[:attributes] if opts[:attributes]
  query_params[:attributeSets] = OCI::ApiClient.build_collection_params(opts[:attribute_sets], :multi) if opts[:attribute_sets] && !opts[:attribute_sets].empty?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_status_changer])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#put_user_status_changer') 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::IdentityDomains::Models::UserStatusChanger'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_account_mgmt_infos(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_account_mgmt_infos API.

Search Account Mgmt Info Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :account_mgmt_info_search_request (OCI::IdentityDomains::Models::AccountMgmtInfoSearchRequest) —

  Parameters for searching AccountMgmtInfos

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AccountMgmtInfos

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20007

def search_account_mgmt_infos(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_account_mgmt_infos.' if logger


  path = '/admin/v1/AccountMgmtInfos/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:account_mgmt_info_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_account_mgmt_infos') 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::IdentityDomains::Models::AccountMgmtInfos'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_api_keys(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_api_keys API.

Search for API keys using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :api_key_search_request (OCI::IdentityDomains::Models::ApiKeySearchRequest) —

  Parameters for searching ApiKeys

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ApiKeys

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20068

def search_api_keys(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_api_keys.' if logger


  path = '/admin/v1/ApiKeys/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:api_key_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_api_keys') 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::IdentityDomains::Models::ApiKeys'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_app_roles(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_app_roles API.

Search AppRoles Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :app_role_search_request (OCI::IdentityDomains::Models::AppRoleSearchRequest) —

  Parameters for searching AppRoles

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AppRoles

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20129

def search_app_roles(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_app_roles.' if logger


  path = '/admin/v1/AppRoles/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:app_role_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_app_roles') 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::IdentityDomains::Models::AppRoles'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_apps(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_apps API.

Search Apps Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :app_search_request (OCI::IdentityDomains::Models::AppSearchRequest) —

  Parameters for searching Apps

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Apps

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20190

def search_apps(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_apps.' if logger


  path = '/admin/v1/Apps/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:app_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_apps') 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::IdentityDomains::Models::Apps'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_auth_tokens(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_auth_tokens API.

Search for Auth tokens using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :auth_token_search_request (OCI::IdentityDomains::Models::AuthTokenSearchRequest) —

  Parameters for searching AuthTokens

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AuthTokens

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20251

def search_auth_tokens(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_auth_tokens.' if logger


  path = '/admin/v1/AuthTokens/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:auth_token_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_auth_tokens') 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::IdentityDomains::Models::AuthTokens'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_authentication_factor_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_authentication_factor_settings API.

Search Authentication Factor Settings Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :authentication_factor_settings_search_request (OCI::IdentityDomains::Models::AuthenticationFactorSettingsSearchRequest) —

  Parameters for searching AuthenticationFactorSettings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type AuthenticationFactorSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20312

def search_authentication_factor_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_authentication_factor_settings.' if logger


  path = '/admin/v1/AuthenticationFactorSettings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:authentication_factor_settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_authentication_factor_settings') 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::IdentityDomains::Models::AuthenticationFactorSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_cloud_gate_mappings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_cloud_gate_mappings API.

Search Cloud Gate mappings Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :cloud_gate_mapping_search_request (OCI::IdentityDomains::Models::CloudGateMappingSearchRequest) —

  Parameters for searching CloudGateMappings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CloudGateMappings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20373

def search_cloud_gate_mappings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_cloud_gate_mappings.' if logger


  path = '/admin/v1/CloudGateMappings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_mapping_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_cloud_gate_mappings') 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::IdentityDomains::Models::CloudGateMappings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_cloud_gate_servers(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_cloud_gate_servers API.

Search Cloud Gate servers Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :cloud_gate_server_search_request (OCI::IdentityDomains::Models::CloudGateServerSearchRequest) —

  Parameters for searching CloudGateServers

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CloudGateServers

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20434

def search_cloud_gate_servers(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_cloud_gate_servers.' if logger


  path = '/admin/v1/CloudGateServers/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_server_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_cloud_gate_servers') 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::IdentityDomains::Models::CloudGateServers'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_cloud_gates(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_cloud_gates API.

Search Cloud Gates Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :cloud_gate_search_request (OCI::IdentityDomains::Models::CloudGateSearchRequest) —

  Parameters for searching CloudGates

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CloudGates

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20495

def search_cloud_gates(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_cloud_gates.' if logger


  path = '/admin/v1/CloudGates/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:cloud_gate_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_cloud_gates') 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::IdentityDomains::Models::CloudGates'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_conditions(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_conditions API.

Search Conditions Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :condition_search_request (OCI::IdentityDomains::Models::ConditionSearchRequest) —

  Parameters for searching Conditions

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Conditions

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20556

def search_conditions(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_conditions.' if logger


  path = '/admin/v1/Conditions/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:condition_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_conditions') 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::IdentityDomains::Models::Conditions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_customer_secret_keys(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_customer_secret_keys API.

Search for customer secret keys using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :customer_secret_key_search_request (OCI::IdentityDomains::Models::CustomerSecretKeySearchRequest) —

  Parameters for searching CustomerSecretKeys

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type CustomerSecretKeys

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20617

def search_customer_secret_keys(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_customer_secret_keys.' if logger


  path = '/admin/v1/CustomerSecretKeys/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:customer_secret_key_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_customer_secret_keys') 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::IdentityDomains::Models::CustomerSecretKeys'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_dynamic_resource_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_dynamic_resource_groups API.

Search for Dynamic Resource Groups using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :dynamic_resource_group_search_request (OCI::IdentityDomains::Models::DynamicResourceGroupSearchRequest) —

  Parameters for searching DynamicResourceGroups

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type DynamicResourceGroups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20678

def search_dynamic_resource_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_dynamic_resource_groups.' if logger


  path = '/admin/v1/DynamicResourceGroups/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:dynamic_resource_group_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_dynamic_resource_groups') 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::IdentityDomains::Models::DynamicResourceGroups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_grants(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_grants API.

Search Grants Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :grant_search_request (OCI::IdentityDomains::Models::GrantSearchRequest) —

  Parameters for searching Grants

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Grants

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20739

def search_grants(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_grants.' if logger


  path = '/admin/v1/Grants/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:grant_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_grants') 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::IdentityDomains::Models::Grants'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_groups API.

Search for groups using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :group_search_request (OCI::IdentityDomains::Models::GroupSearchRequest) —

  Parameters for searching Groups

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Groups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20800

def search_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_groups.' if logger


  path = '/admin/v1/Groups/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:group_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_groups') 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::IdentityDomains::Models::Groups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_identity_providers(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_identity_providers API.

Search Identity Providers Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :identity_provider_search_request (OCI::IdentityDomains::Models::IdentityProviderSearchRequest) —

  Parameters for searching IdentityProviders

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type IdentityProviders

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20861

def search_identity_providers(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_identity_providers.' if logger


  path = '/admin/v1/IdentityProviders/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:identity_provider_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_identity_providers') 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::IdentityDomains::Models::IdentityProviders'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_identity_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_identity_settings API.

Search for Identity settings using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :identity_settings_search_request (OCI::IdentityDomains::Models::IdentitySettingsSearchRequest) —

  Parameters for searching IdentitySettings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type IdentitySettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20922

def search_identity_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_identity_settings.' if logger


  path = '/admin/v1/IdentitySettings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:identity_settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_identity_settings') 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::IdentityDomains::Models::IdentitySettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_kmsi_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_kmsi_settings API.

Search KmsiSettings Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :kmsi_settings_search_request (OCI::IdentityDomains::Models::KmsiSettingsSearchRequest) —

  Parameters for searching KmsiSettings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type KmsiSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 20983

def search_kmsi_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_kmsi_settings.' if logger


  path = '/admin/v1/KmsiSettings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:kmsi_settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_kmsi_settings') 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::IdentityDomains::Models::KmsiSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_my_apps(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_my_apps API.

Search My Apps Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_app_search_request (OCI::IdentityDomains::Models::MyAppSearchRequest) —

  Parameters for searching MyApps

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyApps

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21044

def search_my_apps(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_my_apps.' if logger


  path = '/admin/v1/MyApps/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_app_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_my_apps') 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::IdentityDomains::Models::MyApps'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_my_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_my_groups API.

Search for 'My Groups' using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_group_search_request (OCI::IdentityDomains::Models::MyGroupSearchRequest) —

  Parameters for searching MyGroups

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyGroups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21105

def search_my_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_my_groups.' if logger


  path = '/admin/v1/MyGroups/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_group_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_my_groups') 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::IdentityDomains::Models::MyGroups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_my_requestable_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_my_requestable_groups API.

Search My Requestable Groups Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_requestable_group_search_request (OCI::IdentityDomains::Models::MyRequestableGroupSearchRequest) —

  Parameters for searching MyRequestableGroups

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyRequestableGroups

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21166

def search_my_requestable_groups(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_my_requestable_groups.' if logger


  path = '/admin/v1/MyRequestableGroups/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_requestable_group_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_my_requestable_groups') 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::IdentityDomains::Models::MyRequestableGroups'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_my_requests(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_my_requests API.

Search My Requests Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :my_request_search_request (OCI::IdentityDomains::Models::MyRequestSearchRequest) —

  Parameters for searching MyRequests

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type MyRequests

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21227

def search_my_requests(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_my_requests.' if logger


  path = '/admin/v1/MyRequests/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:my_request_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_my_requests') 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::IdentityDomains::Models::MyRequests'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_network_perimeters(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_network_perimeters API.

Search NetworkPerimeters Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :network_perimeter_search_request (OCI::IdentityDomains::Models::NetworkPerimeterSearchRequest) —

  Parameters for searching NetworkPerimeters

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type NetworkPerimeters

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21288

def search_network_perimeters(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_network_perimeters.' if logger


  path = '/admin/v1/NetworkPerimeters/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:network_perimeter_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_network_perimeters') 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::IdentityDomains::Models::NetworkPerimeters'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_notification_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_notification_settings API.

Search Notification Settings Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :notification_settings_search_request (OCI::IdentityDomains::Models::NotificationSettingsSearchRequest) —

  Parameters for searching NotificationSettings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type NotificationSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21349

def search_notification_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_notification_settings.' if logger


  path = '/admin/v1/NotificationSettings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:notification_settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_notification_settings') 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::IdentityDomains::Models::NotificationSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_o_auth2_client_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_o_auth2_client_credentials API.

Search for OAuth2 client credentials using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :o_auth2_client_credential_search_request (OCI::IdentityDomains::Models::OAuth2ClientCredentialSearchRequest) —

  Parameters for searching OAuth2ClientCredentials

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type OAuth2ClientCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21410

def search_o_auth2_client_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_o_auth2_client_credentials.' if logger


  path = '/admin/v1/OAuth2ClientCredentials/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:o_auth2_client_credential_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_o_auth2_client_credentials') 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::IdentityDomains::Models::OAuth2ClientCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_o_auth_client_certificates(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_o_auth_client_certificates API.

Search OAuth Client Certificates Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :o_auth_client_certificate_search_request (OCI::IdentityDomains::Models::OAuthClientCertificateSearchRequest) —

  Parameters for searching OAuthClientCertificates

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type OAuthClientCertificates

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21471

def search_o_auth_client_certificates(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_o_auth_client_certificates.' if logger


  path = '/admin/v1/OAuthClientCertificates/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:o_auth_client_certificate_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_o_auth_client_certificates') 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::IdentityDomains::Models::OAuthClientCertificates'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_o_auth_partner_certificates(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_o_auth_partner_certificates API.

Search OAuth Partner Certificates Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :o_auth_partner_certificate_search_request (OCI::IdentityDomains::Models::OAuthPartnerCertificateSearchRequest) —

  Parameters for searching OAuthPartnerCertificates

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type OAuthPartnerCertificates

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21532

def search_o_auth_partner_certificates(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_o_auth_partner_certificates.' if logger


  path = '/admin/v1/OAuthPartnerCertificates/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:o_auth_partner_certificate_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_o_auth_partner_certificates') 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::IdentityDomains::Models::OAuthPartnerCertificates'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_password_policies(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_password_policies API.

Search for password policies using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :password_policy_search_request (OCI::IdentityDomains::Models::PasswordPolicySearchRequest) —

  Parameters for searching PasswordPolicies

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type PasswordPolicies

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21593

def search_password_policies(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_password_policies.' if logger


  path = '/admin/v1/PasswordPolicies/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:password_policy_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_password_policies') 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::IdentityDomains::Models::PasswordPolicies'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_policies(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_policies API.

Search Policies Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :policy_search_request (OCI::IdentityDomains::Models::PolicySearchRequest) —

  Parameters for searching Policies

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Policies

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21654

def search_policies(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_policies.' if logger


  path = '/admin/v1/Policies/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:policy_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_policies') 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::IdentityDomains::Models::Policies'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_resource_type_schema_attributes(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_resource_type_schema_attributes API.

Search Resource Type Schema Attributes Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :resource_type_schema_attribute_search_request (OCI::IdentityDomains::Models::ResourceTypeSchemaAttributeSearchRequest) —

  Parameters for searching ResourceTypeSchemaAttributes

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type ResourceTypeSchemaAttributes

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21715

def search_resource_type_schema_attributes(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_resource_type_schema_attributes.' if logger


  path = '/admin/v1/ResourceTypeSchemaAttributes/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:resource_type_schema_attribute_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_resource_type_schema_attributes') 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::IdentityDomains::Models::ResourceTypeSchemaAttributes'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_rules(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_rules API.

Search Rules Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :rule_search_request (OCI::IdentityDomains::Models::RuleSearchRequest) —

  Parameters for searching Rules

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Rules

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21776

def search_rules(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_rules.' if logger


  path = '/admin/v1/Rules/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:rule_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_rules') 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::IdentityDomains::Models::Rules'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_schemas(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_schemas API.

Search Schemas Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :schema_search_request (OCI::IdentityDomains::Models::SchemaSearchRequest) —

  Parameters for searching Schemas

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Schemas

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21837

def search_schemas(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_schemas.' if logger


  path = '/admin/v1/Schemas/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:schema_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_schemas') 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::IdentityDomains::Models::Schemas'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_security_question_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_security_question_settings API.

Search for security question settings using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :security_question_settings_search_request (OCI::IdentityDomains::Models::SecurityQuestionSettingsSearchRequest) —

  Parameters for searching SecurityQuestionSettings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SecurityQuestionSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21898

def search_security_question_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_security_question_settings.' if logger


  path = '/admin/v1/SecurityQuestionSettings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:security_question_settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_security_question_settings') 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::IdentityDomains::Models::SecurityQuestionSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_security_questions(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_security_questions API.

Search for security questions using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :security_question_search_request (OCI::IdentityDomains::Models::SecurityQuestionSearchRequest) —

  Parameters for searching SecurityQuestions

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SecurityQuestions

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 21959

def search_security_questions(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_security_questions.' if logger


  path = '/admin/v1/SecurityQuestions/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:security_question_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_security_questions') 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::IdentityDomains::Models::SecurityQuestions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_self_registration_profiles(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_self_registration_profiles API.

Search for self-registration profile using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :self_registration_profile_search_request (OCI::IdentityDomains::Models::SelfRegistrationProfileSearchRequest) —

  Parameters for searching SelfRegistrationProfiles

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SelfRegistrationProfiles

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 22020

def search_self_registration_profiles(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_self_registration_profiles.' if logger


  path = '/admin/v1/SelfRegistrationProfiles/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:self_registration_profile_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_self_registration_profiles') 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::IdentityDomains::Models::SelfRegistrationProfiles'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_settings API.

Search Settings Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :settings_search_request (OCI::IdentityDomains::Models::SettingsSearchRequest) —

  Parameters for searching Settings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Settings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 22081

def search_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_settings.' if logger


  path = '/admin/v1/Settings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_settings') 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::IdentityDomains::Models::Settings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_smtp_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_smtp_credentials API.

Search for SMTP credentials using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :smtp_credential_search_request (OCI::IdentityDomains::Models::SmtpCredentialSearchRequest) —

  Parameters for searching SmtpCredentials

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type SmtpCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 22142

def search_smtp_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_smtp_credentials.' if logger


  path = '/admin/v1/SmtpCredentials/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:smtp_credential_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_smtp_credentials') 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::IdentityDomains::Models::SmtpCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_user_attributes_settings(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_user_attributes_settings API.

Search User Schema Attribute Settings Using POST

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :user_attributes_settings_search_request (OCI::IdentityDomains::Models::UserAttributesSettingsSearchRequest) —

  Parameters for searching UserAttributesSettings

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type UserAttributesSettings

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 22203

def search_user_attributes_settings(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_user_attributes_settings.' if logger


  path = '/admin/v1/UserAttributesSettings/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_attributes_settings_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_user_attributes_settings') 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::IdentityDomains::Models::UserAttributesSettings'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_user_db_credentials(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_user_db_credentials API.

Search for a user's database (DB) credentials using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :user_db_credentials_search_request (OCI::IdentityDomains::Models::UserDbCredentialsSearchRequest) —

  Parameters for searching UserDbCredentials

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type UserDbCredentials

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 22264

def search_user_db_credentials(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_user_db_credentials.' if logger


  path = '/admin/v1/UserDbCredentials/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_db_credentials_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_user_db_credentials') 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::IdentityDomains::Models::UserDbCredentials'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_users(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use search_users API.

Search for users using POST.

Parameters:

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :authorization (String) —

  The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

• :resource_type_schema_version (String) —

  An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned.

• :user_search_request (OCI::IdentityDomains::Models::UserSearchRequest) —

  Parameters for searching Users

• :opc_retry_token (String) —

  A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.

• :page (String) —

  The value of the opc-next-page response header from the previous 'List' call.

• :limit (Integer) —

  The maximum number of items to return in a paginated 'List' call. (default to 50)

Returns:

• (Response) —

  A Response object with data of type Users

# File 'lib/oci/identity_domains/identity_domains_client.rb', line 22325

def search_users(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#search_users.' if logger


  path = '/admin/v1/Users/.search'
  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, application/scim+json'
  header_params[:'content-type'] = 'application/json'
  header_params[:authorization] = opts[:authorization] if opts[:authorization]
  header_params[:resource_type_schema_version] = opts[:resource_type_schema_version] if opts[:resource_type_schema_version]
  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(opts[:user_search_request])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#search_users') 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::IdentityDomains::Models::Users'
    )
  end
  # rubocop:enable Metrics/BlockLength
end