/segment-iam | Type: Application | PCID required: Yes
Tools
segment_iam_add_permissions_to_user
Add Permissions to User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
permissions | object[] | Yes | — | The permissions to add. |
segment_iam_add_permissions_to_user_group
Add Permissions to User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
permissions | object[] | Yes | — | The permissions to add. |
segment_iam_add_users_to_user_group
Add Users to User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
emails | string[] | Yes | — | The email addresses of the users and invites to add. |
segment_iam_create_invites
Create Invites Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
invites | object[] | Yes | — | The list of invites. |
segment_iam_create_user_group
Create User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the user group to create. |
segment_iam_delete_invites
Delete Invites Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
emails | string[] | Yes | — | The list of emails to delete invites for. This parameter exists in v1. |
segment_iam_delete_user_group
Delete User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
segment_iam_delete_users
Delete Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userIds | string[] | Yes | — | The ids of the users to remove. This parameter exists in v1. |
segment_iam_get_user
Get User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
segment_iam_get_user_group
Get User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
segment_iam_list_invites
List Invites Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagination | object | No | — | Defines the pagination parameters. This parameter exists in v1. |
segment_iam_list_invites_from_user_group
List Invites from User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
pagination | object | No | — | Pagination for invites to the group. This parameter exists in v1. |
segment_iam_list_roles
List Roles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagination | object | No | — | Pagination for roles. This parameter exists in v1. |
segment_iam_list_user_groups
List User Groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagination | object | No | — | Pagination for user groups. This parameter exists in v1. |
segment_iam_list_user_groups_from_user
List User Groups from User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
pagination | object | No | — | Pagination for groups. This parameter exists in v1. |
segment_iam_list_users
List Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pagination | object | No | — | Pagination for users. This parameter exists in v1. |
segment_iam_list_users_from_user_group
List Users from User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
pagination | object | No | — | Pagination for members of a group. This parameter exists in v1. |
segment_iam_remove_users_from_user_group
Remove Users from User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
emails | string[] | Yes | — | The list of emails to remove from the user group. This parameter exists in v1. |
segment_iam_replace_permissions_for_user
Replace Permissions for User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
permissions | object[] | Yes | — | The permissions to add. |
segment_iam_replace_permissions_for_user_group
Replace Permissions for User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
permissions | object[] | Yes | — | The permissions to replace with. |
segment_iam_replace_users_in_user_group
Replace Users in User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
emails | string[] | Yes | — | The email addresses of the users and invites to replace. |
segment_iam_update_user_group
Update User Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userGroupId | string | Yes | — | User Group Id |
name | string | No | — | The intended value to rename the user group to. |

