Class AppScopes.Builder

  • Enclosing class:
    AppScopes

    public static class AppScopes.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • value

        public AppScopes.Builder value​(String value)
        OAuth scope.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

        Parameters:
        value - the value to set
        Returns:
        this builder
      • fqs

        public AppScopes.Builder fqs​(String fqs)
        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

        Parameters:
        fqs - the value to set
        Returns:
        this builder
      • description

        public AppScopes.Builder description​(String description)
        OAuth scope description

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        description - the value to set
        Returns:
        this builder
      • displayName

        public AppScopes.Builder displayName​(String displayName)
        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

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • requiresConsent

        public AppScopes.Builder requiresConsent​(Boolean requiresConsent)
        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

        Parameters:
        requiresConsent - the value to set
        Returns:
        this builder
      • readOnly

        public AppScopes.Builder readOnly​(Boolean readOnly)
        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

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