AppRole

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

Bases: object

AppRole resource.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

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

IDCS_PREVENTED_OPERATIONS_REPLACE

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

IDCS_PREVENTED_OPERATIONS_UPDATE

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

admin_role

Gets the admin_role of this AppRole.

app

[Required] Gets the app of this AppRole.

available_to_clients

Gets the available_to_clients of this AppRole.

available_to_groups

Gets the available_to_groups of this AppRole.

available_to_users

Gets the available_to_users of this AppRole.

compartment_ocid

Gets the compartment_ocid of this AppRole.

delete_in_progress

Gets the delete_in_progress of this AppRole.

description

Gets the description of this AppRole.

display_name

[Required] Gets the display_name of this AppRole.

domain_ocid

Gets the domain_ocid of this AppRole.

id

Gets the id of this AppRole.

idcs_created_by

Gets the idcs_created_by of this AppRole.

idcs_last_modified_by

Gets the idcs_last_modified_by of this AppRole.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this AppRole.

idcs_prevented_operations

Gets the idcs_prevented_operations of this AppRole.

legacy_group_name

Gets the legacy_group_name of this AppRole.

limited_to_one_or_more_groups

Gets the limited_to_one_or_more_groups of this AppRole.

localized_display_name

Gets the localized_display_name of this AppRole.

members

Gets the members of this AppRole.

meta

Gets the meta of this AppRole.

ocid

Gets the ocid of this AppRole.

public

Gets the public of this AppRole.

schemas

[Required] Gets the schemas of this AppRole.

tags

Gets the tags of this AppRole.

tenancy_ocid

Gets the tenancy_ocid of this AppRole.

unique_name

Gets the unique_name of this AppRole.

Methods:

__init__(**kwargs)

Initializes a new AppRole 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 AppRole. 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 AppRole. 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 AppRole. This constant has a value of “update”

__init__(**kwargs)

Initializes a new AppRole 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 AppRole.

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

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

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

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

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

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this AppRole. 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 AppRole.

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

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

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

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

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

  • display_name (str) – The value to assign to the display_name property of this AppRole.

  • unique_name (str) – The value to assign to the unique_name property of this AppRole.

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

  • legacy_group_name (str) – The value to assign to the legacy_group_name property of this AppRole.

  • admin_role (bool) – The value to assign to the admin_role property of this AppRole.

  • limited_to_one_or_more_groups (bool) – The value to assign to the limited_to_one_or_more_groups property of this AppRole.

  • available_to_users (bool) – The value to assign to the available_to_users property of this AppRole.

  • available_to_groups (bool) – The value to assign to the available_to_groups property of this AppRole.

  • available_to_clients (bool) – The value to assign to the available_to_clients property of this AppRole.

  • public (bool) – The value to assign to the public property of this AppRole.

  • localized_display_name (str) – The value to assign to the localized_display_name property of this AppRole.

  • app (oci.identity_domains.models.AppRoleApp) – The value to assign to the app property of this AppRole.

  • members (list[oci.identity_domains.models.AppRoleMembers]) – The value to assign to the members property of this AppRole.

property admin_role

Gets the admin_role of this AppRole. If true, the role provides administrative access privileges.

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The admin_role of this AppRole.

Return type

bool

property app

[Required] Gets the app of this AppRole.

Returns

The app of this AppRole.

Return type

oci.identity_domains.models.AppRoleApp

property available_to_clients

Gets the available_to_clients of this AppRole. If true, this AppRole can be granted to Apps.

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The available_to_clients of this AppRole.

Return type

bool

property available_to_groups

Gets the available_to_groups of this AppRole. If true, this AppRole can be granted to Groups.

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The available_to_groups of this AppRole.

Return type

bool

property available_to_users

Gets the available_to_users of this AppRole. If true, this AppRole can be granted to Users.

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The available_to_users of this AppRole.

Return type

bool

property compartment_ocid

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

Return type

str

property delete_in_progress

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

Return type

bool

property description

Gets the description of this AppRole. AppRole description

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The description of this AppRole.

Return type

str

property display_name

[Required] Gets the display_name of this AppRole. AppRole name

SCIM++ Properties:
  • caseExact: false

  • idcsCsvAttributeName: Display Name

  • idcsCsvAttributeNameMappings: [[columnHeaderName:Entitlement Value]]

  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: true

  • returned: always

  • type: string

  • uniqueness: none

Returns

The display_name of this AppRole.

Return type

str

property domain_ocid

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

Return type

str

property id

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

Return type

str

property idcs_created_by

Gets the idcs_created_by of this AppRole.

Returns

The idcs_created_by of this AppRole.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this AppRole.

Returns

The idcs_last_modified_by of this AppRole.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

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

Return type

str

property idcs_prevented_operations

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

Return type

list[str]

property legacy_group_name

Gets the legacy_group_name of this AppRole. The name of the legacy group associated with this AppRole.

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: string

  • uniqueness: server

Returns

The legacy_group_name of this AppRole.

Return type

str

property limited_to_one_or_more_groups

Gets the limited_to_one_or_more_groups of this AppRole. If true, indicates that this Oracle Identity Cloud Service AppRole can be granted to a delegated administrator whose scope is limited to users that are members of one or more groups.

Added In: 19.2.1

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The limited_to_one_or_more_groups of this AppRole.

Return type

bool

property localized_display_name

Gets the localized_display_name of this AppRole. AppRole localization name

Added In: 2109090424

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: request

  • type: string

  • uniqueness: none

Returns

The localized_display_name of this AppRole.

Return type

str

property members

Gets the members of this AppRole. AppRole members - when requesting members attribute, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]

SCIM++ Properties:
  • idcsCompositeKey: [value, type]

  • idcsCsvAttributeNameMappings: [[columnHeaderName:Grantee Name, mapsTo:members.value], [columnHeaderName:Grantee Type, mapsTo:members.type]]

  • idcsSearchable: true

  • multiValued: true

  • mutability: readOnly

  • required: false

  • returned: request

  • idcsPaginateResponse: true

  • type: complex

  • uniqueness: none

Returns

The members of this AppRole.

Return type

list[oci.identity_domains.models.AppRoleMembers]

property meta

Gets the meta of this AppRole.

Returns

The meta of this AppRole.

Return type

oci.identity_domains.models.Meta

property ocid

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

Return type

str

property public

Gets the public of this AppRole. If true, this AppRole is available automatically to every Oracle Identity Cloud Service User in this tenancy. There is no need to grant it to individual Users or Groups.

SCIM++ Properties:
  • idcsSearchable: true

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The public of this AppRole.

Return type

bool

property schemas

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

Return type

list[str]

property tags

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

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

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

Return type

str

property unique_name

Gets the unique_name of this AppRole. AppRole unique name

SCIM++ Properties:
  • idcsSearchable: false

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: always

  • type: string

  • uniqueness: server

Returns

The unique_name of this AppRole.

Return type

str