Skip to content
Start here

Members

List User Group Members
GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Get User Group Member
GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
Add User Group Members
POST/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Update User Group Members
PUT/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Remove User Group Member
DELETE/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
ModelsExpand Collapse
MemberListResponse object { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email: optional string

The contact email address of the user.

maxLength90
status: optional "accepted" or "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
MemberGetResponse object { id, created_at, email, 2 more }

Detailed member information for a User Group member.

id: string

Account member identifier.

created_at: optional string

When the member was added to the user group.

formatdate-time
email: optional string

The contact email address of the user.

maxLength90
status: optional "accepted" or "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
user: optional object { id, email, first_name, last_name }

Details of the user associated with this membership.

id: optional string

User identifier tag.

email: optional string

The contact email address of the user.

maxLength90
first_name: optional string

User’s first name.

last_name: optional string

User’s last name.

MemberCreateResponse object { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email: optional string

The contact email address of the user.

maxLength90
status: optional "accepted" or "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
MemberUpdateResponse object { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email: optional string

The contact email address of the user.

maxLength90
status: optional "accepted" or "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
MemberDeleteResponse object { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email: optional string

The contact email address of the user.

maxLength90
status: optional "accepted" or "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"