Class Grant

Schema for Grant Resource

Inheritance
object
Grant
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class Grant

Properties

App

Declaration
[JsonProperty(PropertyName = "app")]
public GrantApp App { get; set; }
Property Value
Type Description
GrantApp

AppEntitlementCollection

Declaration
[JsonProperty(PropertyName = "appEntitlementCollection")]
public GrantAppEntitlementCollection AppEntitlementCollection { get; set; }
Property Value
Type Description
GrantAppEntitlementCollection

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

CompositeKey

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

Unique key of grant, composed by combining a subset of app, entitlement, grantee, grantor and grantMechanism. Used to prevent duplicate Grants.
Added In: 18.1.2
SCIM++ Properties:

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

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

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

Entitlement

Declaration
[JsonProperty(PropertyName = "entitlement")]
public GrantEntitlement Entitlement { get; set; }
Property Value
Type Description
GrantEntitlement

GrantMechanism

Declaration
[Required(ErrorMessage = "GrantMechanism is required.")]
[JsonProperty(PropertyName = "grantMechanism")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Grant.GrantMechanismEnum? GrantMechanism { get; set; }
Property Value
Type Description
Grant.GrantMechanismEnum?

Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR':

  • 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User.
  • 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group.
  • 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App.
    SCIM++ Properties:
  • caseExact: true
  • idcsCsvAttributeNameMappings: [[defaultValue:IMPORT_GRANTS]]
  • idcsSearchable: true
  • multiValued: false
  • mutability: immutable
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
Remarks

Required

GrantedAttributeValuesJson

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

Store granted attribute-values as a string in Javascript Object Notation (JSON) format.
Added In: 18.3.4
SCIM++ Properties:

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

Grantee

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

Required

Grantor

Declaration
[JsonProperty(PropertyName = "grantor")]
public GrantGrantor Grantor { get; set; }
Property Value
Type Description
GrantGrantor

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

IsFulfilled

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

If true, this Grant has been fulfilled successfully.
SCIM++ Properties:

  • idcsSearchable: true
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: boolean
  • 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

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