Class AppRole
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.identitydomains.model.AppRole
-
@Generated(value="OracleSDKGenerator", comments="API Version: v1") public final class AppRole extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelAppRole resource.
Note: Objects should always be created or deserialized using theAppRole.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of theAppRole.Builder, which maintain a set of all explicitly set fields calledAppRole.Builder.__explicitlySet__. ThehashCode()andequals(Object)methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAppRole.Builder
-
Constructor Summary
Constructors Constructor Description AppRole(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, String displayName, String uniqueName, String description, String legacyGroupName, Boolean adminRole, Boolean limitedToOneOrMoreGroups, Boolean availableToUsers, Boolean availableToGroups, Boolean availableToClients, Boolean isPublic, String localizedDisplayName, AppRoleApp app, List<AppRoleMembers> members)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AppRole.Builderbuilder()Create a new builder.booleanequals(Object o)BooleangetAdminRole()If true, the role provides administrative access privileges.AppRoleAppgetApp()BooleangetAvailableToClients()If true, this AppRole can be granted to Apps.BooleangetAvailableToGroups()If true, this AppRole can be granted to Groups.BooleangetAvailableToUsers()If true, this AppRole can be granted to Users.StringgetCompartmentOcid()OCI Compartment Id (ocid) in which the resource lives.BooleangetDeleteInProgress()A boolean flag indicating this resource in the process of being deleted.StringgetDescription()AppRole descriptionStringgetDisplayName()AppRole nameStringgetDomainOcid()OCI Domain Id (ocid) in which the resource lives.StringgetId()Unique identifier for the SCIM Resource as defined by the Service Provider.IdcsCreatedBygetIdcsCreatedBy()IdcsLastModifiedBygetIdcsLastModifiedBy()StringgetIdcsLastUpgradedInRelease()The release number when the resource was upgraded.List<IdcsPreventedOperations>getIdcsPreventedOperations()Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.StringgetLegacyGroupName()The name of the legacy group associated with this AppRole.BooleangetLimitedToOneOrMoreGroups()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.StringgetLocalizedDisplayName()AppRole localization nameList<AppRoleMembers>getMembers()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]MetagetMeta()StringgetOcid()Unique OCI identifier for the SCIM Resource.List<String>getSchemas()REQUIRED.List<Tags>getTags()A list of tags on this resource.StringgetTenancyOcid()OCI Tenant Id (ocid) in which the resource lives.StringgetUniqueName()AppRole unique nameinthashCode()BooleanisPublic()If true, this AppRole is available automatically to every Oracle Identity Cloud Service User in this tenancy.AppRole.BuildertoBuilder()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
AppRole
@Deprecated @ConstructorProperties({"id","ocid","schemas","meta","idcsCreatedBy","idcsLastModifiedBy","idcsPreventedOperations","tags","deleteInProgress","idcsLastUpgradedInRelease","domainOcid","compartmentOcid","tenancyOcid","displayName","uniqueName","description","legacyGroupName","adminRole","limitedToOneOrMoreGroups","availableToUsers","availableToGroups","availableToClients","isPublic","localizedDisplayName","app","members"}) public AppRole(String id, String ocid, List<String> schemas, Meta meta, IdcsCreatedBy idcsCreatedBy, IdcsLastModifiedBy idcsLastModifiedBy, List<IdcsPreventedOperations> idcsPreventedOperations, List<Tags> tags, Boolean deleteInProgress, String idcsLastUpgradedInRelease, String domainOcid, String compartmentOcid, String tenancyOcid, String displayName, String uniqueName, String description, String legacyGroupName, Boolean adminRole, Boolean limitedToOneOrMoreGroups, Boolean availableToUsers, Boolean availableToGroups, Boolean availableToClients, Boolean isPublic, String localizedDisplayName, AppRoleApp app, List<AppRoleMembers> members)
Deprecated.
-
-
Method Detail
-
builder
public static AppRole.Builder builder()
Create a new builder.
-
toBuilder
public AppRole.Builder toBuilder()
-
getId
public String getId()
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 value
-
getOcid
public String getOcid()
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 value
-
getSchemas
public List<String> getSchemas()
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 value
-
getMeta
public Meta getMeta()
-
getIdcsCreatedBy
public IdcsCreatedBy getIdcsCreatedBy()
-
getIdcsLastModifiedBy
public IdcsLastModifiedBy getIdcsLastModifiedBy()
-
getIdcsPreventedOperations
public List<IdcsPreventedOperations> getIdcsPreventedOperations()
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
- Returns:
- the value
-
getTags
public List<Tags> getTags()
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 value
-
getDeleteInProgress
public Boolean getDeleteInProgress()
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 value
-
getIdcsLastUpgradedInRelease
public String getIdcsLastUpgradedInRelease()
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 value
-
getDomainOcid
public String getDomainOcid()
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 value
-
getCompartmentOcid
public String getCompartmentOcid()
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 value
-
getTenancyOcid
public String getTenancyOcid()
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 value
-
getDisplayName
public String getDisplayName()
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 value
-
getUniqueName
public String getUniqueName()
AppRole unique name*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: server
- Returns:
- the value
-
getDescription
public String getDescription()
AppRole description*SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none
- Returns:
- the value
-
getLegacyGroupName
public String getLegacyGroupName()
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 value
-
getAdminRole
public Boolean getAdminRole()
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 value
-
getLimitedToOneOrMoreGroups
public Boolean getLimitedToOneOrMoreGroups()
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 value
-
getAvailableToUsers
public Boolean getAvailableToUsers()
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 value
-
getAvailableToGroups
public Boolean getAvailableToGroups()
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 value
-
getAvailableToClients
public Boolean getAvailableToClients()
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 value
-
isPublic
public Boolean isPublic()
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 value
-
getLocalizedDisplayName
public String getLocalizedDisplayName()
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 value
-
getApp
public AppRoleApp getApp()
-
getMembers
public List<AppRoleMembers> getMembers()
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 value
-
toString
public String toString()
- Overrides:
toStringin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCodein classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-