Skip to content
Start here

Members

List User Group Members
iam.user_groups.members.list(struser_group_id, MemberListParams**kwargs) -> SyncV4PagePaginationArray[MemberListResponse]
GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Get User Group Member
iam.user_groups.members.get(strmember_id, MemberGetParams**kwargs) -> MemberGetResponse
GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
Add User Group Members
iam.user_groups.members.create(struser_group_id, MemberCreateParams**kwargs) -> SyncSinglePage[MemberCreateResponse]
POST/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Update User Group Members
iam.user_groups.members.update(struser_group_id, MemberUpdateParams**kwargs) -> SyncSinglePage[MemberUpdateResponse]
PUT/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Remove User Group Member
iam.user_groups.members.delete(strmember_id, MemberDeleteParams**kwargs) -> MemberDeleteResponse
DELETE/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
ModelsExpand Collapse
class MemberListResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The member’s status in the account.

One of the following:
"accepted"
"pending"
class MemberGetResponse:

Detailed member information for a User Group member.

id: str

Account member identifier.

created_at: Optional[datetime]

When the member was added to the user group.

formatdate-time
email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The member’s status in the account.

One of the following:
"accepted"
"pending"
user: Optional[User]

Details of the user associated with this membership.

id: Optional[str]

User identifier tag.

email: Optional[str]

The contact email address of the user.

maxLength90
first_name: Optional[str]

User’s first name.

last_name: Optional[str]

User’s last name.

class MemberCreateResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The member’s status in the account.

One of the following:
"accepted"
"pending"
class MemberUpdateResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The member’s status in the account.

One of the following:
"accepted"
"pending"
class MemberDeleteResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The member’s status in the account.

One of the following:
"accepted"
"pending"