Class: OCI::IdentityDomains::IdentityDomainsClient

Inherits:
Object
  • Object
show all
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 collapse

Instance Method Summary collapse

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# 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:



16
17
18
 
# 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) 


20
21
22
 
# 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:



26
27
28
 
# 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:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# 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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# 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:



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# 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:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# 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:



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# 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:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# 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:



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/oci/identity_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:



696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# 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:



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# 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:



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# 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:



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
 
# 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:



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# 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:



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# 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:



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
 
# 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:



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# 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:



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# 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_propagation_trust(opts = {}) ⇒ Response

Note:

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

Register a new Identity Propagation Trust configuration.

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_propagation_trust (OCI::IdentityDomains::Models::IdentityPropagationTrust) —

    IdentityPropagationTrust 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:



1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1451

def create_identity_propagation_trust(opts = {})
  logger.debug 'Calling operation IdentityDomainsClient#create_identity_propagation_trust.' 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/IdentityPropagationTrusts'
  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_propagation_trust])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityDomainsClient#create_identity_propagation_trust') 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::IdentityPropagationTrust'
    )
  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:



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1536

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



1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1621

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:



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1703

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:



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1773

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:



1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1843

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:



1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1913

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:



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 1983

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:



2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2053

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:



2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2123

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:



2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2196

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:



2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2278

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:



2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2348

def (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:



2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2418

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:



2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2491

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:



2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2576

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:



2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2658

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:



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2728

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:



2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2801

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:



2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2886

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:



2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 2971

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:



3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3056

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:



3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3141

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:



3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3226

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:



3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3311

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:



3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3396

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



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3467

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



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3529

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



3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3591

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



3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3653

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



3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3715

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



3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
 
# File 'lib/oci/identity_domains/identity_domains_client.rb', line 3777

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?