Package com.atlan.api

Class IdentityEndpoint

java.lang.Object
com.atlan.api.AbstractEndpoint
com.atlan.api.HeraclesEndpoint
com.atlan.api.IdentityEndpoint
public class IdentityEndpoint extends HeraclesEndpoint
API endpoints for the Redis-backed IAM identity service (/identity/...). Provides bulk lookups for user group memberships and group aliases, replacing per-user Keycloak calls that fail at high user volumes.

  • Constructor Details

    • IdentityEndpoint

      public IdentityEndpoint(AtlanClient client)

  • Method Details

    • getUserGroups

      public Map<String,List<AtlanGroup>> getUserGroups(List<String> userIds) throws AtlanException
      Bulk-fetch group memberships for the given user IDs.
      Parameters:
      userIds - list of user IDs to look up
      Returns:
      map of userId to list of AtlanGroup (id + Keycloak group name)
      Throws:
      AtlanException - on any API communication issue

    • getUserGroups

      public Map<String,List<AtlanGroup>> getUserGroups(List<String> userIds, int batchSize) throws AtlanException
      Bulk-fetch group memberships for the given user IDs.
      Parameters:
      userIds - list of user IDs to look up
      batchSize - number of IDs per request
      Returns:
      map of userId to list of AtlanGroup (id + Keycloak group name)
      Throws:
      AtlanException - on any API communication issue

    • getUsers

      public Map<String,AtlanUser> getUsers(List<String> userIds) throws AtlanException
      Bulk-fetch full user details (including group memberships) for the given user IDs. Returns each user's id, username, email, enabled, firstName, lastName, createdTimestamp, groups, and attributes in a single API call per batch, eliminating the need for a separate getUserGroups(java.util.List<java.lang.String>) call.
      Parameters:
      userIds - list of user IDs to look up
      Returns:
      map of userId to AtlanUser
      Throws:
      AtlanException - on any API communication issue

    • getUsers

      public Map<String,AtlanUser> getUsers(List<String> userIds, int batchSize) throws AtlanException
      Bulk-fetch full user details (including group memberships) for the given user IDs.
      Parameters:
      userIds - list of user IDs to look up
      batchSize - number of IDs per request
      Returns:
      map of userId to AtlanUser
      Throws:
      AtlanException - on any API communication issue

    • getGroupAliases

      public Map<String,String> getGroupAliases(List<String> groupIds) throws AtlanException
      Bulk-fetch group aliases (display names) for the given group IDs.
      Parameters:
      groupIds - list of group IDs to look up
      Returns:
      map of groupId to alias (display name), empty string if no alias set
      Throws:
      AtlanException - on any API communication issue

    • getGroupAliases

      public Map<String,String> getGroupAliases(List<String> groupIds, int batchSize) throws AtlanException
      Bulk-fetch group aliases (display names) for the given group IDs.
      Parameters:
      groupIds - list of group IDs to look up
      batchSize - number of IDs per request
      Returns:
      map of groupId to alias (display name), empty string if no alias set
      Throws:
      AtlanException - on any API communication issue