Docs/User API/Organizations/List members

List members

Preview

GET/user/v1/organizations/{organizationId}/members

List organization members.

path parameters

organizationId
string
Required
The identifier of the organization.

query parameters

pageSize
int32
The maximum number of members to return. The API may return fewer than this value.
If unspecified, at most 20 members will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
A page token, received from a previous list members call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list members must match the call that provided the page token.
orderBy
string
A comma-separated list of fields to order by.

Returns

members
Member[]
The list of members.
user
User
The user.
id
string
The system-assigned identifier of the user.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
imageUrl
string
The photo/avatar URL of the user.
disabled
boolean
Whether the user is disabled.
role
Role
The user's role within the organization.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
seatPolicy
enum
The policy that defines how a member is assigned a seat.
Possible values:
DEFAULTMANUAL
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
seat
AccountSubscriptionSeat
The seat assigned to the member.
This will be absent if there is no active subscription for the organization or the user has not been assigned a seat.
product
Product
The seat product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

members
Member[]
The list of members.
user
User
The user.
id
string
The system-assigned identifier of the user.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
imageUrl
string
The photo/avatar URL of the user.
disabled
boolean
Whether the user is disabled.
role
Role
The user's role within the organization.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
seatPolicy
enum
The policy that defines how a member is assigned a seat.
Possible values:
DEFAULTMANUAL
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
seat
AccountSubscriptionSeat
The seat assigned to the member.
This will be absent if there is no active subscription for the organization or the user has not been assigned a seat.
product
Product
The seat product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
nextPageToken
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
previousPageToken
string
A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

curl https://api.userhub.com/user/v1/organizations/org_28seyVGVL1got6/members \
  -H "UserHub-Api-Key: $USERHUB_USER_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

const res = await userApi.organizations.listMembers(
  "org_28seyVGVL1got6",
);

res, err := userApi.Organizations().ListMembers(
    context.Background(),
    "org_28seyVGVL1got6",
    nil,
)

$res = $userApi->organizations->listMembers(
    organizationId: 'org_28seyVGVL1got6',
);

res = user_api.organizations.list_members(
    organization_id="org_28seyVGVL1got6",
)

Response bodyJSON

{
  "members": [
    {
      "user": {
        "id": "usr_MKFxzgJaAH8JQ4",
        "displayName": "Jane Doe",
        "email": "[email protected]",
        "emailVerified": true,
        "imageUrl": "https://example.com/jane.jpg"
      },
      "role": {
        "id": "role_2mD13uXP",
        "uniqueId": "member",
        "displayName": "Member",
        "type": "MEMBER",
        "seatPolicy": "DEFAULT",
        "permissionSets": [
          "members.invite"
        ],
        "default": true
      }
    }
  ]
}

PreviousUpdate an organization

NextGet a member

List members

.css-10iahqc{text-transform:capitalize;}path parameters

query parameters

Returns

path parameters