Assign seat to member
PreviewPOST/user/v1/organizations/{organizationId}/members/{userId}:assignSeat
Assign a seat to an organization member.
This will automatically purchase additional seats if none are available and the plan has just-in-time seat provisioning enabled.
path parameters
organizationId
string
RequiredThe identifier of the organization.
The identifier of the user.
Returns
The system-assigned identifier of the user.
The client defined unique identifier of the user account.
The human-readable display name of the user.
The email address of the user.
Whether the user's email address has been verified.
The photo/avatar URL of the user.
Whether the user is disabled.
The user's role within the organization.
The system-assigned identifier of the role.
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.
The human-readable display name of the role.
Possible values:OWNERMEMBERGUEST
The description of the role.
The maximum length is 1000 characters.
The policy that defines how a member is assigned a seat.
Possible values:DEFAULTMANUAL
The additional permissions allowed by the role.
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.
The system-assigned identifier of the product.
The client defined unique identifier of the product.
The human-readable display name of the product.
The system-assigned identifier of the user.
The client defined unique identifier of the user account.
The human-readable display name of the user.
The email address of the user.
Whether the user's email address has been verified.
The photo/avatar URL of the user.
Whether the user is disabled.
The user's role within the organization.
The system-assigned identifier of the role.
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.
The human-readable display name of the role.
Possible values:OWNERMEMBERGUEST
The description of the role.
The maximum length is 1000 characters.
The policy that defines how a member is assigned a seat.
Possible values:DEFAULTMANUAL
The additional permissions allowed by the role.
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.
The system-assigned identifier of the product.
The client defined unique identifier of the product.
The human-readable display name of the product.
curl https://api.userhub.com/user/v1/organizations/org_28seyVGVL1got6/members/usr_MKFxzgJaAH8JQ4:assignSeat \
-H "UserHub-Api-Key: $USERHUB_USER_KEY" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN" \
-X POST
const res = await userApi.organizations.assignMemberSeat(
"org_28seyVGVL1got6",
"usr_MKFxzgJaAH8JQ4",
);
res, err := userApi.Organizations().AssignMemberSeat(
context.Background(),
"org_28seyVGVL1got6",
"usr_MKFxzgJaAH8JQ4",
nil,
)
$res = $userApi->organizations->assignMemberSeat(
organizationId: 'org_28seyVGVL1got6',
userId: 'usr_MKFxzgJaAH8JQ4',
);
res = user_api.organizations.assign_member_seat(
organization_id="org_28seyVGVL1got6",
user_id="usr_MKFxzgJaAH8JQ4",
)
Response bodyJSON
{
"user": {
"id": "usr_MKFxzgJaAH8JQ4",
"displayName": "Jane Doe",
"email": "[email protected]",
"emailVerified": true,
"imageUrl": "https://example.com/jane.jpg"
},
"role": {
"id": "role_4NNSzkhn",
"uniqueId": "owner",
"displayName": "Owner",
"type": "OWNER",
"seatPolicy": "DEFAULT",
"permissionSets": [],
"default": false
},
"seat": {
"product": {
"id": "pd_3fNK5BXs9C1Fdc",
"uniqueId": "pro-seat",
"displayName": "Pro seat"
}
}
}