1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. ListUsersWithRoleResponse

ListUsersWithRoleResponse

    ListUsersWithRoleResponse is the shape of the response when listing users with a given role within an organization.

    Properties

    • users array[UserInfo] required
      Users that have been explicitly configured to the given role (ie, not configured via default role).
    • ↳ name string required
      The user’s display name.
    • ↳ githubLogin string required
      The user’s login name.
    • ↳ avatarUrl string required
      The URL of the user’s avatar image.
    • ↳ email string optional
      IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information.