MyOAuth2ClientCredential

class oci.identity_domains.models.MyOAuth2ClientCredential(**kwargs)

Bases: object

The user’s OAuth2 client credentials.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

A constant which can be used with the idcs_prevented_operations property of a MyOAuth2ClientCredential.

IDCS_PREVENTED_OPERATIONS_REPLACE

A constant which can be used with the idcs_prevented_operations property of a MyOAuth2ClientCredential.

IDCS_PREVENTED_OPERATIONS_UPDATE

A constant which can be used with the idcs_prevented_operations property of a MyOAuth2ClientCredential.

STATUS_ACTIVE

A constant which can be used with the status property of a MyOAuth2ClientCredential.

STATUS_INACTIVE

A constant which can be used with the status property of a MyOAuth2ClientCredential.

compartment_ocid

Gets the compartment_ocid of this MyOAuth2ClientCredential.

delete_in_progress

Gets the delete_in_progress of this MyOAuth2ClientCredential.

description

Gets the description of this MyOAuth2ClientCredential.

domain_ocid

Gets the domain_ocid of this MyOAuth2ClientCredential.

expires_on

Gets the expires_on of this MyOAuth2ClientCredential.

id

Gets the id of this MyOAuth2ClientCredential.

idcs_created_by

Gets the idcs_created_by of this MyOAuth2ClientCredential.

idcs_last_modified_by

Gets the idcs_last_modified_by of this MyOAuth2ClientCredential.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this MyOAuth2ClientCredential.

idcs_prevented_operations

Gets the idcs_prevented_operations of this MyOAuth2ClientCredential.

is_reset_secret

Gets the is_reset_secret of this MyOAuth2ClientCredential.

meta

Gets the meta of this MyOAuth2ClientCredential.

name

[Required] Gets the name of this MyOAuth2ClientCredential.

ocid

Gets the ocid of this MyOAuth2ClientCredential.

schemas

[Required] Gets the schemas of this MyOAuth2ClientCredential.

scopes

[Required] Gets the scopes of this MyOAuth2ClientCredential.

status

Gets the status of this MyOAuth2ClientCredential.

tags

Gets the tags of this MyOAuth2ClientCredential.

tenancy_ocid

Gets the tenancy_ocid of this MyOAuth2ClientCredential.

user

Gets the user of this MyOAuth2ClientCredential.

Methods:

__init__(**kwargs)

Initializes a new MyOAuth2ClientCredential object with values from keyword arguments.

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'

A constant which can be used with the idcs_prevented_operations property of a MyOAuth2ClientCredential. This constant has a value of “delete”

IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'

A constant which can be used with the idcs_prevented_operations property of a MyOAuth2ClientCredential. This constant has a value of “replace”

IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'

A constant which can be used with the idcs_prevented_operations property of a MyOAuth2ClientCredential. This constant has a value of “update”

STATUS_ACTIVE = 'ACTIVE'

A constant which can be used with the status property of a MyOAuth2ClientCredential. This constant has a value of “ACTIVE”

STATUS_INACTIVE = 'INACTIVE'

A constant which can be used with the status property of a MyOAuth2ClientCredential. This constant has a value of “INACTIVE”

__init__(**kwargs)

Initializes a new MyOAuth2ClientCredential object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this MyOAuth2ClientCredential.

  • ocid (str) – The value to assign to the ocid property of this MyOAuth2ClientCredential.

  • schemas (list[str]) – The value to assign to the schemas property of this MyOAuth2ClientCredential.

  • meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this MyOAuth2ClientCredential.

  • idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this MyOAuth2ClientCredential.

  • idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this MyOAuth2ClientCredential.

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this MyOAuth2ClientCredential. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this MyOAuth2ClientCredential.

  • delete_in_progress (bool) – The value to assign to the delete_in_progress property of this MyOAuth2ClientCredential.

  • idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this MyOAuth2ClientCredential.

  • domain_ocid (str) – The value to assign to the domain_ocid property of this MyOAuth2ClientCredential.

  • compartment_ocid (str) – The value to assign to the compartment_ocid property of this MyOAuth2ClientCredential.

  • tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this MyOAuth2ClientCredential.

  • name (str) – The value to assign to the name property of this MyOAuth2ClientCredential.

  • description (str) – The value to assign to the description property of this MyOAuth2ClientCredential.

  • status (str) – The value to assign to the status property of this MyOAuth2ClientCredential. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • expires_on (str) – The value to assign to the expires_on property of this MyOAuth2ClientCredential.

  • is_reset_secret (bool) – The value to assign to the is_reset_secret property of this MyOAuth2ClientCredential.

  • scopes (list[oci.identity_domains.models.MyOAuth2ClientCredentialScopes]) – The value to assign to the scopes property of this MyOAuth2ClientCredential.

  • user (oci.identity_domains.models.MyOAuth2ClientCredentialUser) – The value to assign to the user property of this MyOAuth2ClientCredential.

property compartment_ocid

Gets the compartment_ocid of this MyOAuth2ClientCredential. 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

Returns

The compartment_ocid of this MyOAuth2ClientCredential.

Return type

str

property delete_in_progress

Gets the delete_in_progress of this MyOAuth2ClientCredential. 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

Returns

The delete_in_progress of this MyOAuth2ClientCredential.

Return type

bool

property description

Gets the description of this MyOAuth2ClientCredential. Description

Added In: 2101262133

SCIM++ Properties:
  • caseExact: false

  • type: string

  • mutability: readWrite

  • required: false

  • returned: default

Returns

The description of this MyOAuth2ClientCredential.

Return type

str

property domain_ocid

Gets the domain_ocid of this MyOAuth2ClientCredential. 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

Returns

The domain_ocid of this MyOAuth2ClientCredential.

Return type

str

property expires_on

Gets the expires_on of this MyOAuth2ClientCredential. When the user’s credentials expire.

Added In: 2109090424

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: dateTime

  • uniqueness: none

Returns

The expires_on of this MyOAuth2ClientCredential.

Return type

str

property id

Gets the id of this MyOAuth2ClientCredential. 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

Returns

The id of this MyOAuth2ClientCredential.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this MyOAuth2ClientCredential.

Returns

The idcs_created_by of this MyOAuth2ClientCredential.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this MyOAuth2ClientCredential.

Returns

The idcs_last_modified_by of this MyOAuth2ClientCredential.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this MyOAuth2ClientCredential. 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

Returns

The idcs_last_upgraded_in_release of this MyOAuth2ClientCredential.

Return type

str

property idcs_prevented_operations

Gets the idcs_prevented_operations of this MyOAuth2ClientCredential. 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

Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The idcs_prevented_operations of this MyOAuth2ClientCredential.

Return type

list[str]

property is_reset_secret

Gets the is_reset_secret of this MyOAuth2ClientCredential. Specifies whether the secret must be reset.

Added In: 2109090424

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: writeOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The is_reset_secret of this MyOAuth2ClientCredential.

Return type

bool

property meta

Gets the meta of this MyOAuth2ClientCredential.

Returns

The meta of this MyOAuth2ClientCredential.

Return type

oci.identity_domains.models.Meta

property name

[Required] Gets the name of this MyOAuth2ClientCredential. Name

SCIM++ Properties:
  • caseExact: false

  • type: string

  • mutability: readWrite

  • required: true

  • returned: default

Returns

The name of this MyOAuth2ClientCredential.

Return type

str

property ocid

Gets the ocid of this MyOAuth2ClientCredential. 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

Returns

The ocid of this MyOAuth2ClientCredential.

Return type

str

property schemas

[Required] Gets the schemas of this MyOAuth2ClientCredential. 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

Returns

The schemas of this MyOAuth2ClientCredential.

Return type

list[str]

property scopes

[Required] Gets the scopes of this MyOAuth2ClientCredential. Scopes

SCIM++ Properties:
  • caseExact: false

  • idcsCompositeKey: [audience, scope]

  • type: complex

  • mutability: readWrite

  • multiValued: true

  • required: true

  • returned: default

Returns

The scopes of this MyOAuth2ClientCredential.

Return type

list[oci.identity_domains.models.MyOAuth2ClientCredentialScopes]

property status

Gets the status of this MyOAuth2ClientCredential. The user’s credential status.

Added In: 2109090424

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: never

  • type: string

  • uniqueness: none

Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The status of this MyOAuth2ClientCredential.

Return type

str

property tags

Gets the tags of this MyOAuth2ClientCredential. 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

Returns

The tags of this MyOAuth2ClientCredential.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

Gets the tenancy_ocid of this MyOAuth2ClientCredential. 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

Returns

The tenancy_ocid of this MyOAuth2ClientCredential.

Return type

str

property user

Gets the user of this MyOAuth2ClientCredential.

Returns

The user of this MyOAuth2ClientCredential.

Return type

oci.identity_domains.models.MyOAuth2ClientCredentialUser