org.keycloak.representations.idm.authorization

## Class ScopeRepresentation

- java.lang.Object
- - org.keycloak.representations.idm.authorization.ScopeRepresentation

-     public class ScopeRepresentation
      extends Object

  A bounded extent of access that is possible to perform on a resource set. In authorization policy terminology, a scope is one of the potentially many "verbs" that can logically apply to a resource set ("object").

  For more details, OAuth-resource-reg.

  Author:
    Pedro Igor

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ScopeRepresentation()` Creates an instance.
    `ScopeRepresentation(String name)` Creates an instance.
    `ScopeRepresentation(String name, String iconUri)` Creates an instance.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object o)`
    `String` | `getIconUri()`
    `String` | `getId()`
    `String` | `getName()`
    `List<PolicyRepresentation>` | `getPolicies()`
    `List<ResourceRepresentation>` | `getResources()`
    `int` | `hashCode()`
    `void` | `setIconUri(String iconUri)`
    `void` | `setId(String id)`
    `void` | `setName(String name)`
    `void` | `setPolicies(List<PolicyRepresentation> policies)`
    `void` | `setResources(List<ResourceRepresentation> resources)`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ScopeRepresentation

          public ScopeRepresentation(String name,
                                     String iconUri)

      Creates an instance.
      Parameters:
        `name` - the a human-readable string describing some scope (extent) of access
        `iconUri` - a `URI` for a graphic icon representing the scope

    - #### ScopeRepresentation

          public ScopeRepresentation(String name)

      Creates an instance.
      Parameters:
        `name` - the a human-readable string describing some scope (extent) of access

    - #### ScopeRepresentation

          public ScopeRepresentation()

      Creates an instance.

  - ### Method Detail

    - #### getName

          public String getName()

    - #### getIconUri

          public String getIconUri()

    - #### getId

          public String getId()

    - #### setId

          public void setId(String id)

    - #### setName

          public void setName(String name)

    - #### setIconUri

          public void setIconUri(String iconUri)

    - #### getPolicies

          public List<PolicyRepresentation> getPolicies()

    - #### setPolicies

          public void setPolicies(List<PolicyRepresentation> policies)

    - #### getResources

          public List<ResourceRepresentation> getResources()

    - #### setResources

          public void setResources(List<ResourceRepresentation> resources)

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

Copyright © 2016 JBoss by Red Hat. All rights reserved.