Show / Hide Table of Contents

Class AppRole

AppRole resource.

Inheritance
object
AppRole
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class AppRole

Properties

AdminRole

Declaration
[JsonProperty(PropertyName = "adminRole")]
public bool? AdminRole { get; set; }
Property Value
Type Description
bool?

If true, the role provides administrative access privileges.
SCIM++ Properties:

  • idcsSearchable: true
  • multiValued: false
  • mutability: immutable
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none

App

Declaration
[Required(ErrorMessage = "App is required.")]
[JsonProperty(PropertyName = "app")]
public AppRoleApp App { get; set; }
Property Value
Type Description
AppRoleApp
Remarks

Required

AvailableToClients

Declaration
[JsonProperty(PropertyName = "availableToClients")]
public bool? AvailableToClients { get; set; }
Property Value
Type Description
bool?

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

AvailableToGroups

Declaration
[JsonProperty(PropertyName = "availableToGroups")]
public bool? AvailableToGroups { get; set; }
Property Value
Type Description
bool?

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

AvailableToUsers

Declaration
[JsonProperty(PropertyName = "availableToUsers")]
public bool? AvailableToUsers { get; set; }
Property Value
Type Description
bool?

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

CompartmentOcid

Declaration
[JsonProperty(PropertyName = "compartmentOcid")]
public string CompartmentOcid { get; set; }
Property Value
Type Description
string

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

DeleteInProgress

Declaration
[JsonProperty(PropertyName = "deleteInProgress")]
public bool? DeleteInProgress { get; set; }
Property Value
Type Description
bool?

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

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

AppRole description
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: string
  • uniqueness: none

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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
Remarks

Required

DomainOcid

Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }
Property Value
Type Description
string

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

Id

Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

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

IdcsCreatedBy

Declaration
[JsonProperty(PropertyName = "idcsCreatedBy")]
public IdcsCreatedBy IdcsCreatedBy { get; set; }
Property Value
Type Description
IdcsCreatedBy

IdcsLastModifiedBy

Declaration
[JsonProperty(PropertyName = "idcsLastModifiedBy")]
public IdcsLastModifiedBy IdcsLastModifiedBy { get; set; }
Property Value
Type Description
IdcsLastModifiedBy

IdcsLastUpgradedInRelease

Declaration
[JsonProperty(PropertyName = "idcsLastUpgradedInRelease")]
public string IdcsLastUpgradedInRelease { get; set; }
Property Value
Type Description
string

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

IdcsPreventedOperations

Declaration
[JsonProperty(PropertyName = "idcsPreventedOperations", ItemConverterType = typeof(ResponseEnumConverter))]
public List<IdcsPreventedOperations> IdcsPreventedOperations { get; set; }
Property Value
Type Description
List<IdcsPreventedOperations>

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

LegacyGroupName

Declaration
[JsonProperty(PropertyName = "legacyGroupName")]
public string LegacyGroupName { get; set; }
Property Value
Type Description
string

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

LimitedToOneOrMoreGroups

Declaration
[JsonProperty(PropertyName = "limitedToOneOrMoreGroups")]
public bool? LimitedToOneOrMoreGroups { get; set; }
Property Value
Type Description
bool?

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

LocalizedDisplayName

Declaration
[JsonProperty(PropertyName = "localizedDisplayName")]
public string LocalizedDisplayName { get; set; }
Property Value
Type Description
string

AppRole localization name
Added In: 2109090424
SCIM++ Properties:

  • caseExact: false
  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: request
  • type: string
  • uniqueness: none

Members

Declaration
[JsonProperty(PropertyName = "members")]
public List<AppRoleMembers> Members { get; set; }
Property Value
Type Description
List<AppRoleMembers>

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

Meta

Declaration
[JsonProperty(PropertyName = "meta")]
public Meta Meta { get; set; }
Property Value
Type Description
Meta

Ocid

Declaration
[JsonProperty(PropertyName = "ocid")]
public string Ocid { get; set; }
Property Value
Type Description
string

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

Declaration
[JsonProperty(PropertyName = "public")]
public bool? Public { get; set; }
Property Value
Type Description
bool?

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

Schemas

Declaration
[Required(ErrorMessage = "Schemas is required.")]
[JsonProperty(PropertyName = "schemas")]
public List<string> Schemas { get; set; }
Property Value
Type Description
List<string>

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
Remarks

Required

Tags

Declaration
[JsonProperty(PropertyName = "tags")]
public List<Tags> Tags { get; set; }
Property Value
Type Description
List<Tags>

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

TenancyOcid

Declaration
[JsonProperty(PropertyName = "tenancyOcid")]
public string TenancyOcid { get; set; }
Property Value
Type Description
string

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

UniqueName

Declaration
[JsonProperty(PropertyName = "uniqueName")]
public string UniqueName { get; set; }
Property Value
Type Description
string

AppRole unique name
SCIM++ Properties:

  • idcsSearchable: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: always
  • type: string
  • uniqueness: server
In this article
Back to top