ApiAuthRole (cloudera-manager-api-swagger 7.13.1 API)
Date: 2026-05-19

com.cloudera.api.swagger.model

## Class ApiAuthRole

- java.lang.Object
- - com.cloudera.api.swagger.model.ApiAuthRole

-     @Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
                 date="2026-05-19T08:00:51.241Z[Etc/UTC]")
      public class ApiAuthRole
      extends Object

  This is the model for user role scope in the API since v18. This is used to support granular permissions.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ApiAuthRole()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `ApiAuthRole` | `addClustersItem(ApiClusterRef clustersItem)`
    `ApiAuthRole` | `addExternalUserMappingsItem(ApiExternalUserMappingRef externalUserMappingsItem)`
    `ApiAuthRole` | `addUsersItem(ApiUser2Ref usersItem)`
    `ApiAuthRole` | `baseRole(ApiAuthRoleRef baseRole)`
    `ApiAuthRole` | `clusters(List<ApiClusterRef> clusters)`
    `ApiAuthRole` | `displayName(String displayName)`
    `boolean` | `equals(Object o)`
    `ApiAuthRole` | `externalUserMappings(List<ApiExternalUserMappingRef> externalUserMappings)`
    `ApiAuthRoleRef` | `getBaseRole()` Get baseRole
    `List<ApiClusterRef>` | `getClusters()` Get clusters
    `String` | `getDisplayName()` Get displayName
    `List<ApiExternalUserMappingRef>` | `getExternalUserMappings()` Get externalUserMappings
    `String` | `getName()` Get name
    `List<ApiUser2Ref>` | `getUsers()` Get users
    `String` | `getUuid()` Readonly.
    `int` | `hashCode()`
    `ApiAuthRole` | `isCustom(Boolean isCustom)`
    `Boolean` | `isIsCustom()` Get isCustom
    `ApiAuthRole` | `name(String name)`
    `void` | `setBaseRole(ApiAuthRoleRef baseRole)`
    `void` | `setClusters(List<ApiClusterRef> clusters)`
    `void` | `setDisplayName(String displayName)`
    `void` | `setExternalUserMappings(List<ApiExternalUserMappingRef> externalUserMappings)`
    `void` | `setIsCustom(Boolean isCustom)`
    `void` | `setName(String name)`
    `void` | `setUsers(List<ApiUser2Ref> users)`
    `void` | `setUuid(String uuid)`
    `String` | `toString()`
    `ApiAuthRole` | `users(List<ApiUser2Ref> users)`
    `ApiAuthRole` | `uuid(String uuid)`

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

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

- - ### Constructor Detail

    - #### ApiAuthRole

          public ApiAuthRole()

  - ### Method Detail

    - #### displayName

          public ApiAuthRole displayName(String displayName)

    - #### getDisplayName

          public String getDisplayName()

      Get displayName
      Returns:
        displayName

    - #### setDisplayName

          public void setDisplayName(String displayName)

    - #### name

          public ApiAuthRole name(String name)

    - #### getName

          public String getName()

      Get name
      Returns:
        name

    - #### setName

          public void setName(String name)

    - #### clusters

          public ApiAuthRole clusters(List<ApiClusterRef> clusters)

    - #### addClustersItem

          public ApiAuthRole addClustersItem(ApiClusterRef clustersItem)

    - #### getClusters

          public List<ApiClusterRef> getClusters()

      Get clusters
      Returns:
        clusters

    - #### setClusters

          public void setClusters(List<ApiClusterRef> clusters)

    - #### users

          public ApiAuthRole users(List<ApiUser2Ref> users)

    - #### addUsersItem

          public ApiAuthRole addUsersItem(ApiUser2Ref usersItem)

    - #### getUsers

          public List<ApiUser2Ref> getUsers()

      Get users
      Returns:
        users

    - #### setUsers

          public void setUsers(List<ApiUser2Ref> users)

    - #### externalUserMappings

          public ApiAuthRole externalUserMappings(List<ApiExternalUserMappingRef> externalUserMappings)

    - #### addExternalUserMappingsItem

          public ApiAuthRole addExternalUserMappingsItem(ApiExternalUserMappingRef externalUserMappingsItem)

    - #### getExternalUserMappings

          public List<ApiExternalUserMappingRef> getExternalUserMappings()

      Get externalUserMappings
      Returns:
        externalUserMappings

    - #### setExternalUserMappings

          public void setExternalUserMappings(List<ApiExternalUserMappingRef> externalUserMappings)

    - #### baseRole

          public ApiAuthRole baseRole(ApiAuthRoleRef baseRole)

    - #### getBaseRole

          public ApiAuthRoleRef getBaseRole()

      Get baseRole
      Returns:
        baseRole

    - #### setBaseRole

          public void setBaseRole(ApiAuthRoleRef baseRole)

    - #### uuid

          public ApiAuthRole uuid(String uuid)

    - #### getUuid

          public String getUuid()

      Readonly. The UUID of the authRole. <p>
      Returns:
        uuid

    - #### setUuid

          public void setUuid(String uuid)

    - #### isCustom

          public ApiAuthRole isCustom(Boolean isCustom)

    - #### isIsCustom

          public Boolean isIsCustom()

      Get isCustom
      Returns:
        isCustom

    - #### setIsCustom

          public void setIsCustom(Boolean isCustom)

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2026. All rights reserved.