Skip to main content
Server path: /segment-iam | Type: Application | PCID required: Yes

Tools


segment_iam_add_permissions_to_user

Add Permissions to User Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
permissionsobject[]YesThe permissions to add.

segment_iam_add_permissions_to_user_group

Add Permissions to User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
permissionsobject[]YesThe permissions to add.

segment_iam_add_users_to_user_group

Add Users to User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
emailsstring[]YesThe email addresses of the users and invites to add.

segment_iam_create_invites

Create Invites Parameters:
ParameterTypeRequiredDefaultDescription
invitesobject[]YesThe list of invites.

segment_iam_create_user_group

Create User Group Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the user group to create.

segment_iam_delete_invites

Delete Invites Parameters:
ParameterTypeRequiredDefaultDescription
emailsstring[]YesThe list of emails to delete invites for. This parameter exists in v1.

segment_iam_delete_user_group

Delete User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id

segment_iam_delete_users

Delete Users Parameters:
ParameterTypeRequiredDefaultDescription
userIdsstring[]YesThe ids of the users to remove. This parameter exists in v1.

segment_iam_get_user

Get User Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id

segment_iam_get_user_group

Get User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id

segment_iam_list_invites

List Invites Parameters:
ParameterTypeRequiredDefaultDescription
paginationobjectNoDefines the pagination parameters. This parameter exists in v1.

segment_iam_list_invites_from_user_group

List Invites from User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
paginationobjectNoPagination for invites to the group. This parameter exists in v1.

segment_iam_list_roles

List Roles Parameters:
ParameterTypeRequiredDefaultDescription
paginationobjectNoPagination for roles. This parameter exists in v1.

segment_iam_list_user_groups

List User Groups Parameters:
ParameterTypeRequiredDefaultDescription
paginationobjectNoPagination for user groups. This parameter exists in v1.

segment_iam_list_user_groups_from_user

List User Groups from User Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
paginationobjectNoPagination for groups. This parameter exists in v1.

segment_iam_list_users

List Users Parameters:
ParameterTypeRequiredDefaultDescription
paginationobjectNoPagination for users. This parameter exists in v1.

segment_iam_list_users_from_user_group

List Users from User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
paginationobjectNoPagination for members of a group. This parameter exists in v1.

segment_iam_remove_users_from_user_group

Remove Users from User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
emailsstring[]YesThe 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:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser Id
permissionsobject[]YesThe permissions to add.

segment_iam_replace_permissions_for_user_group

Replace Permissions for User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
permissionsobject[]YesThe permissions to replace with.

segment_iam_replace_users_in_user_group

Replace Users in User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
emailsstring[]YesThe email addresses of the users and invites to replace.

segment_iam_update_user_group

Update User Group Parameters:
ParameterTypeRequiredDefaultDescription
userGroupIdstringYesUser Group Id
namestringNoThe intended value to rename the user group to.