SettingsTenantCustomClaims

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

Bases: object

Custom claims associated with the specific tenant

Attributes:

MODE_ALWAYS

A constant which can be used with the mode property of a SettingsTenantCustomClaims.

MODE_NEVER

A constant which can be used with the mode property of a SettingsTenantCustomClaims.

MODE_REQUEST

A constant which can be used with the mode property of a SettingsTenantCustomClaims.

TOKEN_TYPE_AT

A constant which can be used with the token_type property of a SettingsTenantCustomClaims.

TOKEN_TYPE_BOTH

A constant which can be used with the token_type property of a SettingsTenantCustomClaims.

TOKEN_TYPE_IT

A constant which can be used with the token_type property of a SettingsTenantCustomClaims.

all_scopes

[Required] Gets the all_scopes of this SettingsTenantCustomClaims.

expression

[Required] Gets the expression of this SettingsTenantCustomClaims.

mode

[Required] Gets the mode of this SettingsTenantCustomClaims.

name

[Required] Gets the name of this SettingsTenantCustomClaims.

scopes

Gets the scopes of this SettingsTenantCustomClaims.

token_type

[Required] Gets the token_type of this SettingsTenantCustomClaims.

value

[Required] Gets the value of this SettingsTenantCustomClaims.

Methods:

__init__(**kwargs)

Initializes a new SettingsTenantCustomClaims object with values from keyword arguments.

MODE_ALWAYS = 'always'

A constant which can be used with the mode property of a SettingsTenantCustomClaims. This constant has a value of “always”

MODE_NEVER = 'never'

A constant which can be used with the mode property of a SettingsTenantCustomClaims. This constant has a value of “never”

MODE_REQUEST = 'request'

A constant which can be used with the mode property of a SettingsTenantCustomClaims. This constant has a value of “request”

TOKEN_TYPE_AT = 'AT'

A constant which can be used with the token_type property of a SettingsTenantCustomClaims. This constant has a value of “AT”

TOKEN_TYPE_BOTH = 'BOTH'

A constant which can be used with the token_type property of a SettingsTenantCustomClaims. This constant has a value of “BOTH”

TOKEN_TYPE_IT = 'IT'

A constant which can be used with the token_type property of a SettingsTenantCustomClaims. This constant has a value of “IT”

__init__(**kwargs)

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

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

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

  • mode (str) – The value to assign to the mode property of this SettingsTenantCustomClaims. Allowed values for this property are: “always”, “request”, “never”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • expression (bool) – The value to assign to the expression property of this SettingsTenantCustomClaims.

  • all_scopes (bool) – The value to assign to the all_scopes property of this SettingsTenantCustomClaims.

  • token_type (str) – The value to assign to the token_type property of this SettingsTenantCustomClaims. Allowed values for this property are: “AT”, “IT”, “BOTH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property all_scopes

[Required] Gets the all_scopes of this SettingsTenantCustomClaims. Indicates if the custom claim is associated with all scopes

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The all_scopes of this SettingsTenantCustomClaims.

Return type

bool

property expression

[Required] Gets the expression of this SettingsTenantCustomClaims. Indicates if the custom claim is an expression

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: boolean

  • uniqueness: none

Returns

The expression of this SettingsTenantCustomClaims.

Return type

bool

property mode

[Required] Gets the mode of this SettingsTenantCustomClaims. Indicates under what scenario the custom claim will be return

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

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

Returns

The mode of this SettingsTenantCustomClaims.

Return type

str

property name

[Required] Gets the name of this SettingsTenantCustomClaims. Custom claim name

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: server

Returns

The name of this SettingsTenantCustomClaims.

Return type

str

property scopes

Gets the scopes of this SettingsTenantCustomClaims. Scopes associated with a specific custom claim

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: default

  • type: string

  • uniqueness: none

Returns

The scopes of this SettingsTenantCustomClaims.

Return type

list[str]

property token_type

[Required] Gets the token_type of this SettingsTenantCustomClaims. Indicates what type of token the custom claim will be embedded

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

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

Returns

The token_type of this SettingsTenantCustomClaims.

Return type

str

property value

[Required] Gets the value of this SettingsTenantCustomClaims. Custom claim value

Added In: 18.4.2

SCIM++ Properties:
  • multiValued: false

  • mutability: readWrite

  • required: true

  • returned: default

  • type: string

  • uniqueness: none

Returns

The value of this SettingsTenantCustomClaims.

Return type

str