AppScopes¶
- class oci.identity_domains.models.AppScopes(**kwargs)¶
Bases:
objectScopes defined by this App. Used when this App acts as an OAuth Resource.
Methods:
__init__(**kwargs)Initializes a new AppScopes object with values from keyword arguments.
Attributes:
Gets the description of this AppScopes.
Gets the display_name of this AppScopes.
Gets the fqs of this AppScopes.
Gets the read_only of this AppScopes.
Gets the requires_consent of this AppScopes.
[Required] Gets the value of this AppScopes.
- __init__(**kwargs)¶
Initializes a new AppScopes object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
value (str) – The value to assign to the value property of this AppScopes.
fqs (str) – The value to assign to the fqs property of this AppScopes.
description (str) – The value to assign to the description property of this AppScopes.
display_name (str) – The value to assign to the display_name property of this AppScopes.
requires_consent (bool) – The value to assign to the requires_consent property of this AppScopes.
read_only (bool) – The value to assign to the read_only property of this AppScopes.
- property description¶
Gets the description of this AppScopes. OAuth scope description
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The description of this AppScopes.
- Return type
str
- property display_name¶
Gets the display_name of this AppScopes. OAuth scope display name
Added In: 19.2.1
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The display_name of this AppScopes.
- Return type
str
- property fqs¶
Gets the fqs of this AppScopes. The fully qualified value of this scope within this App. A fully qualified scope combines the ‘value’ of each scope with the value of ‘audience’. Each value of ‘fqs’ must be unique across the system. Used only when this App acts as an OAuth Resource.
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: server
- Returns
The fqs of this AppScopes.
- Return type
str
- property read_only¶
Gets the read_only of this AppScopes. If true, indicates that this value must be protected.
Added In: 18.2.2
- SCIM++ Properties:
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: request
type: boolean
uniqueness: none
- Returns
The read_only of this AppScopes.
- Return type
bool
- property requires_consent¶
Gets the requires_consent of this AppScopes. If true, indicates that a user must provide consent to access this scope. Note: Used only when this App acts as an OAuth Resource.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: boolean
uniqueness: none
- Returns
The requires_consent of this AppScopes.
- Return type
bool
- property value¶
[Required] Gets the value of this AppScopes. OAuth scope.
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none
- Returns
The value of this AppScopes.
- Return type
str