oci-cli 3.71.1__py3-none-any.whl → 3.71.3__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/identity-domains/mapped-attribute/patch.txt

@@ -0,0 +1,177 @@
+"patch"
+*******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Update a Mapped Attribute
+
+The top level –endpoint parameter must be supplied for this operation.
+
+
+Usage
+=====
+
+   oci identity-domains mapped-attribute patch [OPTIONS]
+
+
+Required Parameters
+===================
+
+--mapped-attribute-id [text]
+
+ID of the resource
+
+--operations [complex type]
+
+The body of an HTTP PATCH request MUST contain the attribute
+“Operations”, whose value is an array of one or more patch operations.
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--schemas [complex type]
+
+The schemas attribute is an array of Strings which allows
+introspection of the supported schema version for a SCIM
+representation as well any schema extensions supported by that
+representation. Each String value must be a unique URI. All
+representations of SCIM schema MUST include a non-zero value array
+with value(s) of the URIs supported by that representation. Duplicate
+values MUST NOT be included. Value order is not specified and MUST not
+impact behavior. REQUIRED. This is a complex type whose value must be
+valid JSON. The value can be provided as a string on the command line
+or passed in as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+
+Optional Parameters
+===================
+
+--attribute-sets [text]
+
+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.
+
+Accepted values are:
+
+   all, always, default, never, request
+
+--attributes [text]
+
+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.
+
+--authorization [text]
+
+The Authorization field value consists of credentials containing the
+authentication information of the user agent for the realm of the
+resource being requested.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--if-match [text]
+
+Used to make the request conditional on an ETag
+
+--resource-type-schema-version [text]
+
+An endpoint-specific schema version number to use in the Request.
+Allowed version values are Earliest Version or Latest Version as
+specified in each REST API endpoint description, or any sequential
+number inbetween. All schema attributes/body parameters are a part of
+version 1. After version 1, any attributes added or deprecated will be
+tagged with the version that they were added to or deprecated in. If
+no version is provided, the latest schema version is returned.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+endpoint", "--generate-full-command-json-input", "--generate-param-
+json-input", "--help", "--latest-version", "--max-retries", "--no-
+retry", "--opc-client-request-id", "--opc-request-id", "--output", "--
+profile", "--proxy", "--query", "--raw-output", "--read-timeout", "--
+realm-specific-endpoint", "--region", "--release-info", "--request-
+id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci identity-domains mapped-attribute patch --generate-param-json-input operations > operations.json
+       oci identity-domains mapped-attribute patch --generate-param-json-input schemas > schemas.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export mapped_attribute_id=<substitute-value-of-mapped_attribute_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/mapped-attribute/patch.html#cmdoption-mapped-attribute-id
+
+       oci identity-domains mapped-attribute patch --mapped-attribute-id $mapped_attribute_id --operations file://operations.json --schemas file://schemas.json

oci_cli/help_text_producer/data_files/text/cmdref/identity-domains/mapped-attribute/put.txt

@@ -0,0 +1,385 @@
+"put"
+*****
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Replace a Mapped Attribute
+
+The top level –endpoint parameter must be supplied for this operation.
+
+
+Usage
+=====
+
+   oci identity-domains mapped-attribute put [OPTIONS]
+
+
+Required Parameters
+===================
+
+--direction [text]
+
+Direction of the attribute mapping. inbound indicates mapping is from
+source ManagedObjectClass to Oracle Identity Cloud Service
+ResourceType. outbound indicates mapping is from Oracle Identity Cloud
+Service Resource Type to target ManagedObjectClass.
+
+**SCIM++ Properties:**  - caseExact: true  - idcsSearchable: true  -
+multiValued: false  - mutability: immutable  - required: true  -
+returned: default  - type: string  - uniqueness: none
+
+Accepted values are:
+
+   inbound, outbound
+
+--idcs-resource-type [text]
+
+The Oracle Identity Cloud Service Resource Type for which the mapping
+is being done
+
+**SCIM++ Properties:**  - caseExact: true  - idcsSearchable: true  -
+multiValued: false  - mutability: immutable  - required: true  -
+returned: default  - type: string  - uniqueness: none
+
+Accepted values are:
+
+   Container, Group, User
+
+--mapped-attribute-id [text]
+
+ID of the resource
+
+--ref-resource-id [text]
+
+Soft Reference to store Resource ID that holds the mapping
+
+**Added In:** 17.4.6
+
+**SCIM++ Properties:**  - caseExact: true  - idcsSearchable: true  -
+multiValued: false  - mutability: readOnly  - required: true  -
+returned: default  - type: string  - uniqueness: none
+
+--ref-resource-type [text]
+
+The Reference Resource Type that holds the mapping
+
+**Added In:** 17.4.2
+
+**SCIM++ Properties:**  - caseExact: true  - idcsSearchable: true  -
+multiValued: false  - mutability: readOnly  - required: true  -
+returned: default  - type: string  - uniqueness: none
+
+Accepted values are:
+
+   AccountObjectClass, App, IdentityProvider, ManagedObjectClass
+
+--schemas [complex type]
+
+REQUIRED. The schemas attribute is an array of Strings which allows
+introspection of the supported schema version for a SCIM
+representation as well any schema extensions supported by that
+representation. Each String value must be a unique URI. This
+specification defines URIs for User, Group, and a standard
+“enterprise” extension. All representations of SCIM schema MUST
+include a non-zero value array with value(s) of the URIs supported by
+that representation. Duplicate values MUST NOT be included. Value
+order is not specified and MUST not impact behavior.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: false  -
+multiValued: true  - mutability: readWrite  - required: true  -
+returned: default  - type: string  - uniqueness: none This is a
+complex type whose value must be valid JSON. The value can be provided
+as a string on the command line or passed in as a file using the
+file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+
+Optional Parameters
+===================
+
+--attribute-mappings [complex type]
+
+A list of attribute mappings between Oracle Identity Cloud Service
+Resource Type and Account Object Class
+
+**SCIM++ Properties:**  - idcsCompositeKey: [idcsAttributeName,
+managedObjectAttributeName]  - idcsSearchable: true  - multiValued:
+true  - mutability: readWrite  - required: false  - returned: default
+- type: complex  - uniqueness: none
+
+This option is a JSON list with items of type
+MappedAttributeAttributeMappings.  For documentation on
+MappedAttributeAttributeMappings please see our API reference: https:
+//docs.cloud.oracle.com/api/#/en/identitydomains/v1/datatypes/MappedA
+ttributeAttributeMappings. This is a complex type whose value must be
+valid JSON. The value can be provided as a string on the command line
+or passed in as a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--attribute-sets [text]
+
+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.
+
+Accepted values are:
+
+   all, always, default, never, request
+
+--attributes [text]
+
+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.
+
+--authorization [text]
+
+The Authorization field value consists of credentials containing the
+authentication information of the user agent for the realm of the
+resource being requested.
+
+--compartment-ocid [text]
+
+OCI Compartment Id (ocid) in which the resource lives.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: false  -
+multiValued: false  - mutability: readOnly  - required: false  -
+returned: default  - type: string  - uniqueness: none
+
+--delete-in-progress [boolean]
+
+A boolean flag indicating this resource in the process of being
+deleted. Usually set to true when synchronous deletion of the resource
+would take too long.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: true  -
+multiValued: false  - mutability: readOnly  - required: false  -
+returned: default  - type: boolean  - uniqueness: none
+
+--domain-ocid [text]
+
+OCI Domain Id (ocid) in which the resource lives.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: false  -
+multiValued: false  - mutability: readOnly  - required: false  -
+returned: default  - type: string  - uniqueness: none
+
+--force
+
+Perform update without prompting for confirmation.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--id [text]
+
+Unique identifier for the SCIM Resource as defined by the Service
+Provider. Each representation of the Resource MUST include a non-empty
+id value. This identifier MUST be unique across the Service Provider’s
+entire set of Resources. It MUST be a stable, non-reassignable
+identifier that does not change when the same Resource is returned in
+subsequent requests. The value of the id attribute is always issued by
+the Service Provider and MUST never be specified by the Service
+Consumer. bulkId: is a reserved keyword and MUST NOT be used in the
+unique identifier.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: true  -
+multiValued: false  - mutability: readOnly  - required: false  -
+returned: always  - type: string  - uniqueness: global
+
+--idcs-created-by [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--idcs-last-modified-by [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--idcs-last-upgraded-in-release [text]
+
+The release number when the resource was upgraded.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: false  -
+multiValued: false  - mutability: readOnly  - required: false  -
+returned: request  - type: string  - uniqueness: none
+
+--idcs-prevented-operations [text]
+
+Each value of this attribute specifies an operation that only an
+internal client may perform on this particular resource.
+
+**SCIM++ Properties:**  - idcsSearchable: false  - multiValued: true
+- mutability: readOnly  - required: false  - returned: request  -
+type: string  - uniqueness: none
+
+Accepted values are:
+
+   delete, replace, update
+
+--if-match [text]
+
+Used to make the request conditional on an ETag
+
+--meta [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--ocid [text]
+
+Unique OCI identifier for the SCIM Resource.
+
+**SCIM++ Properties:**  - caseExact: true  - idcsSearchable: true  -
+multiValued: false  - mutability: immutable  - required: false  -
+returned: default  - type: string  - uniqueness: global
+
+--resource-type-schema-version [text]
+
+An endpoint-specific schema version number to use in the Request.
+Allowed version values are Earliest Version or Latest Version as
+specified in each REST API endpoint description, or any sequential
+number inbetween. All schema attributes/body parameters are a part of
+version 1. After version 1, any attributes added or deprecated will be
+tagged with the version that they were added to or deprecated in. If
+no version is provided, the latest schema version is returned.
+
+--tags [complex type]
+
+A list of tags on this resource.
+
+**SCIM++ Properties:**  - idcsCompositeKey: [key, value]  -
+idcsSearchable: true  - multiValued: true  - mutability: readWrite  -
+required: false  - returned: request  - type: complex  - uniqueness:
+none
+
+This option is a JSON list with items of type Tags.  For documentation
+on tags please see our API reference: https://docs.cloud.oracle.com/a
+pi/#/en/identitydomains/v1/datatypes/Tags. This is a complex type
+whose value must be valid JSON. The value can be provided as a string
+on the command line or passed in as a file using the
+file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--tenancy-ocid [text]
+
+OCI Tenant Id (ocid) in which the resource lives.
+
+**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: false  -
+multiValued: false  - mutability: readOnly  - required: false  -
+returned: default  - type: string  - uniqueness: none
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--enable-dual-stack", "--enable-propagation", "--
+endpoint", "--generate-full-command-json-input", "--generate-param-
+json-input", "--help", "--latest-version", "--max-retries", "--no-
+retry", "--opc-client-request-id", "--opc-request-id", "--output", "--
+profile", "--proxy", "--query", "--raw-output", "--read-timeout", "--
+realm-specific-endpoint", "--region", "--release-info", "--request-
+id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci identity-domains mapped-attribute put --generate-param-json-input schemas > schemas.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export direction=<substitute-value-of-direction> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/mapped-attribute/put.html#cmdoption-direction
+       export idcs_resource_type=<substitute-value-of-idcs_resource_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/mapped-attribute/put.html#cmdoption-idcs-resource-type
+       export mapped_attribute_id=<substitute-value-of-mapped_attribute_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/mapped-attribute/put.html#cmdoption-mapped-attribute-id
+       export ref_resource_id=<substitute-value-of-ref_resource_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/mapped-attribute/put.html#cmdoption-ref-resource-id
+       export ref_resource_type=<substitute-value-of-ref_resource_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/mapped-attribute/put.html#cmdoption-ref-resource-type
+
+       oci identity-domains mapped-attribute put --direction $direction --idcs-resource-type $idcs_resource_type --mapped-attribute-id $mapped_attribute_id --ref-resource-id $ref_resource_id --ref-resource-type $ref_resource_type --schemas file://schemas.json