Package com.oracle.bmc.identitydomains.model

Class Grant.Builder

  • Enclosing class:
    Grant
    public static class Grant.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Grant.Builder id​(String id)
        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

        Parameters:
        id - the value to set
        Returns:
        this builder

      • ocid

        public Grant.Builder ocid​(String ocid)
        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

        Parameters:
        ocid - the value to set
        Returns:
        this builder

      • schemas

        public Grant.Builder schemas​(List<String> schemas)
        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

        Parameters:
        schemas - the value to set
        Returns:
        this builder

      • idcsPreventedOperations

        public Grant.Builder idcsPreventedOperations​(List<IdcsPreventedOperations> 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

        Parameters:
        idcsPreventedOperations - the value to set
        Returns:
        this builder

      • tags

        public Grant.Builder tags​(List<Tags> 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

        Parameters:
        tags - the value to set
        Returns:
        this builder

      • deleteInProgress

        public Grant.Builder deleteInProgress​(Boolean deleteInProgress)
        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

        Parameters:
        deleteInProgress - the value to set
        Returns:
        this builder

      • idcsLastUpgradedInRelease

        public Grant.Builder idcsLastUpgradedInRelease​(String idcsLastUpgradedInRelease)
        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

        Parameters:
        idcsLastUpgradedInRelease - the value to set
        Returns:
        this builder

      • domainOcid

        public Grant.Builder domainOcid​(String domainOcid)
        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

        Parameters:
        domainOcid - the value to set
        Returns:
        this builder

      • compartmentOcid

        public Grant.Builder compartmentOcid​(String compartmentOcid)
        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

        Parameters:
        compartmentOcid - the value to set
        Returns:
        this builder

      • tenancyOcid

        public Grant.Builder tenancyOcid​(String tenancyOcid)
        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

        Parameters:
        tenancyOcid - the value to set
        Returns:
        this builder

      • grantMechanism

        public Grant.Builder grantMechanism​(Grant.GrantMechanism grantMechanism)
        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

        Parameters:
        grantMechanism - the value to set
        Returns:
        this builder

      • compositeKey

        public Grant.Builder compositeKey​(String compositeKey)
        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

        Parameters:
        compositeKey - the value to set
        Returns:
        this builder

      • isFulfilled

        public Grant.Builder isFulfilled​(Boolean isFulfilled)
        If true, this Grant has been fulfilled successfully.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isFulfilled - the value to set
        Returns:
        this builder

      • grantedAttributeValuesJson

        public Grant.Builder grantedAttributeValuesJson​(String grantedAttributeValuesJson)
        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

        Parameters:
        grantedAttributeValuesJson - the value to set
        Returns:
        this builder

      • build

        public Grant build()