"create"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Register a new Identity Propagation Trust configuration.

The top level –endpoint parameter must be supplied for this operation.


Usage
=====

   oci identity-domains identity-propagation-trust create [OPTIONS]


Required Parameters
===================

--issuer [text]

The issuer claim of the Identity provider.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: true  - mutability: readWrite  - returned: always  -
caseExact: true  - idcsSearchable: true  - uniqueness: server

--name [text]

The name of the the Identity Propagation Trust.

**SCIM++ Properties:**  - type: string  - caseExact: false  -
idcsSearchable: true  - multiValued: false  - required: true  -
mutability: immutable  - returned: default  - uniqueness: none

--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.

--type [text]

The type of the inbound token from the Identity cloud provider.

**SCIM++ Properties:**  - caseExact: true  - idcsSearchable: false  -
required: true  - mutability: readWrite  - returned: default  - type:
string  - multiValued: false  - uniqueness: none

Accepted values are:

   AWS, JWT, SAML, SPNEGO


Optional Parameters
===================

--account-id [text]

The Identity cloud provider service identifier, for example, the Azure
Tenancy ID, AWS Account ID, or GCP Project ID.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
caseExact: true  - idcsSearchable: true  - uniqueness: none

--active [boolean]

If true, specifies that this Identity Propagation Trust is in an
enabled state. The default value is false.

**SCIM++ Properties:**  - type: boolean  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - idcsSearchable: true

--allow-impersonation [boolean]

Allow customers to define whether the resulting token should contain
the authenticated user as the subject or whether the token should
impersonate another Application Principal in IAM.

**SCIM++ Properties:**  - type: boolean  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - idcsSearchable: false

--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.

--client-claim-name [text]

The claim name that identifies to whom the JWT/SAML token is issued.
If AWS, then “aud” or “client_id”. If Azure, then “appid”. If GCP,
then “aud”.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - idcsSearchable: false

--client-claim-values [complex type]

The value that corresponds to the client claim name used to identify
to whom the token is issued.

**SCIM++ Properties:**  - type: string  - multiValued: true  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - caseExact: true  - idcsSearchable: false 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.

--clock-skew-seconds [integer]

The clock skew (in secs) that’s allowed for the token issue and expiry
time.

**Added In:** 2308181911

**SCIM++ Properties:**  - caseExact: false  - idcsSearchable: false  -
multiValued: false  - mutability: readWrite  - required: false  -
returned: default  - type: integer  - uniqueness: none

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

--description [text]

The description of the Identity Propagation Trust.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - caseExact: false  - idcsSearchable: false

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

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

--impersonation-service-users [complex type]

The Impersonating Principal.

**SCIM++ Properties:**  - idcsCompositeKey: [rule, value]  -
idcsSearchable: false  - multiValued: true  - mutability: readWrite  -
required: false  - returned: request  - type: complex  - uniqueness:
none

This option is a JSON list with items of type
IdentityPropagationTrustImpersonationServiceUsers.  For documentation
on IdentityPropagationTrustImpersonationServiceUsers please see our
API reference: https://docs.cloud.oracle.com/api/#/en/identitydomains
/v1/datatypes/IdentityPropagationTrustImpersonationServiceUsers. 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.

--keytab [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.

--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.

--oauth-clients [complex type]

The value of all the authorized OAuth Clients.

**SCIM++ Properties:**  - idcsSearchable: false  - multiValued: true
- mutability: readWrite  - required: false  - 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.

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

--public-certificate [text]

Store the public key if public key cert.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - idcsSearchable: false

--public-key-endpoint [text]

The cloud provider’s public key API of SAML and OIDC providers for
signature validation.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - caseExact: false  - idcsSearchable: false

--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.

--service-principals [complex type]

The value of all the authorized OCI Service Principals.

**SCIM++ Properties:**  - idcsSearchable: false  - multiValued: true
- mutability: readWrite  - required: false  - 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.

--subject-claim-name [text]

Used for locating the subject claim from the incoming token.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
required: false  - mutability: readWrite  - returned: default  -
uniqueness: none  - caseExact: true  - idcsSearchable: false

--subject-mapping-attribute [text]

Subject Mapping Attribute to which the value from subject claim name
value would be used for identity lookup.

**SCIM++ Properties:**  - type: string  - multiValued: false  -
idcsSearchable: false  - required: false  - mutability: readWrite  -
returned: default  - uniqueness: none

--subject-type [text]

The type of the resource against which lookup will be made in the
identity domain in IAM for the incoming subject claim value.

**SCIM++ Properties:**  - idcsSearchable: false  - multiValued: false
- mutability: readWrite  - required: false  - returned: default  -
type: string  - uniqueness: none

Accepted values are:

   App, User

--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", "--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 identity-propagation-trust create --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 issuer=<substitute-value-of-issuer> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/identity-propagation-trust/create.html#cmdoption-issuer
       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/identity-propagation-trust/create.html#cmdoption-name
       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/identity-domains/identity-propagation-trust/create.html#cmdoption-type

       oci identity-domains identity-propagation-trust create --issuer $issuer --name $name --schemas file://schemas.json --type $type
