segment-iam

Segment IAM — manage users, groups, roles, and permissions

Server path: /segment-iam | Type: Application | PCID required: Yes

Tools

Tool	Description
segment_iam_add_permissions_to_user	Add Permissions to User
segment_iam_add_permissions_to_user_group	Add Permissions to User Group
segment_iam_add_users_to_user_group	Add Users to User Group
segment_iam_create_invites	Create Invites
segment_iam_create_user_group	Create User Group
segment_iam_delete_invites	Delete Invites
segment_iam_delete_user_group	Delete User Group
segment_iam_delete_users	Delete Users
segment_iam_get_user	Get User
segment_iam_get_user_group	Get User Group
segment_iam_list_invites	List Invites
segment_iam_list_invites_from_user_group	List Invites from User Group
segment_iam_list_roles	List Roles
segment_iam_list_user_groups	List User Groups
segment_iam_list_user_groups_from_user	List User Groups from User
segment_iam_list_users	List Users
segment_iam_list_users_from_user_group	List Users from User Group
segment_iam_remove_users_from_user_group	Remove Users from User Group
segment_iam_replace_permissions_for_user	Replace Permissions for User
segment_iam_replace_permissions_for_user_group	Replace Permissions for User Group
segment_iam_replace_users_in_user_group	Replace Users in User Group
segment_iam_update_user_group	Update User Group

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User Id"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "description": "The role id of this permission."
          },
          "resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The id of this resource."
                },
                "type": {
                  "type": "string",
                  "description": "The type for this resource."
                },
                "labels": {
                  "type": "array",
                  "description": "The labels that further refine access to this resource. Labels are exclusive to Workspace-level permissions."
                }
              }
            },
            "description": "The resources to link the selected role to."
          }
        },
        "required": [
          "resources",
          "roleId"
        ]
      },
      "description": "The permissions to add."
    }
  },
  "required": [
    "PCID",
    "userId",
    "permissions"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "description": "The role id of this permission."
          },
          "resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The id of this resource."
                },
                "type": {
                  "type": "string",
                  "description": "The type for this resource."
                },
                "labels": {
                  "type": "array",
                  "description": "The labels that further refine access to this resource. Labels are exclusive to Workspace-level permissions."
                }
              }
            },
            "description": "The resources to link the selected role to."
          }
        },
        "required": [
          "resources",
          "roleId"
        ]
      },
      "description": "The permissions to add."
    }
  },
  "required": [
    "PCID",
    "userGroupId",
    "permissions"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The email addresses of the users and invites to add."
    }
  },
  "required": [
    "PCID",
    "userGroupId",
    "emails"
  ]
}

---

segment_iam_create_invites

Create Invites

Parameters:

Parameter	Type	Required	Default	Description
invites	object[]	Yes	—	The list of invites.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "invites": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "The invited user's email to attach the permissions to."
          },
          "permissions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "roleId": {
                  "type": "string",
                  "description": "The id of the role."
                },
                "resources": {
                  "type": "array",
                  "description": "The resources to grant the invited users access to."
                },
                "labels": {
                  "type": "array",
                  "description": "The labels that determine which resources to grant users access to."
                }
              }
            },
            "description": "The permissions to attach to the invited user."
          }
        },
        "required": [
          "email"
        ]
      },
      "description": "The list of invites."
    }
  },
  "required": [
    "PCID",
    "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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name of the user group to create."
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of emails to delete invites for.  This parameter exists in v1."
    }
  },
  "required": [
    "PCID",
    "emails"
  ]
}

---

segment_iam_delete_user_group

Delete User Group

Parameters:

Parameter	Type	Required	Default	Description
userGroupId	string	Yes	—	User Group Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    }
  },
  "required": [
    "PCID",
    "userGroupId"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The ids of the users to remove.  This parameter exists in v1."
    }
  },
  "required": [
    "PCID",
    "userIds"
  ]
}

---

segment_iam_get_user

Get User

Parameters:

Parameter	Type	Required	Default	Description
userId	string	Yes	—	User Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User Id"
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

segment_iam_get_user_group

Get User Group

Parameters:

Parameter	Type	Required	Default	Description
userGroupId	string	Yes	—	User Group Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    }
  },
  "required": [
    "PCID",
    "userGroupId"
  ]
}

---

segment_iam_list_invites

List Invites

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Defines the pagination parameters. This parameter exists in v1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Defines the pagination parameters.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "pagination": {
      "type": "object",
      "description": "Pagination for invites to the group.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID",
    "userGroupId"
  ]
}

---

segment_iam_list_roles

List Roles

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Pagination for roles. This parameter exists in v1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Pagination for roles.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Pagination for user groups.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User Id"
    },
    "pagination": {
      "type": "object",
      "description": "Pagination for groups.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

---

segment_iam_list_users

List Users

Parameters:

Parameter	Type	Required	Default	Description
pagination	object	No	—	Pagination for users. This parameter exists in v1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pagination": {
      "type": "object",
      "description": "Pagination for users.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "pagination": {
      "type": "object",
      "description": "Pagination for members of a group.  This parameter exists in v1.",
      "properties": {
        "cursor": {
          "type": "string",
          "description": "The page to request.  Acceptable values to use here are in PaginationOutput objects, in the `current`, `next`, and `previous` keys.  Consumers of the API must treat this value as opaque."
        },
        "count": {
          "type": "integer",
          "description": "The number of items to retrieve in a page, between 1 and 1000."
        }
      },
      "required": [
        "count"
      ]
    }
  },
  "required": [
    "PCID",
    "userGroupId"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of emails to remove from the user group.  This parameter exists in v1."
    }
  },
  "required": [
    "PCID",
    "userGroupId",
    "emails"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User Id"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "description": "The role id of this permission."
          },
          "resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The id of this resource."
                },
                "type": {
                  "type": "string",
                  "description": "The type for this resource."
                },
                "labels": {
                  "type": "array",
                  "description": "The labels that further refine access to this resource. Labels are exclusive to Workspace-level permissions."
                }
              }
            },
            "description": "The resources to link the selected role to."
          }
        },
        "required": [
          "resources",
          "roleId"
        ]
      },
      "description": "The permissions to add."
    }
  },
  "required": [
    "PCID",
    "userId",
    "permissions"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "description": "The role id of this permission."
          },
          "resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The id of this resource."
                },
                "type": {
                  "type": "string",
                  "description": "The type for this resource."
                },
                "labels": {
                  "type": "array",
                  "description": "The labels that further refine access to this resource. Labels are exclusive to Workspace-level permissions."
                }
              }
            },
            "description": "The resources to link the selected role to."
          }
        },
        "required": [
          "resources",
          "roleId"
        ]
      },
      "description": "The permissions to replace with."
    }
  },
  "required": [
    "PCID",
    "userGroupId",
    "permissions"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The email addresses of the users and invites to replace."
    }
  },
  "required": [
    "PCID",
    "userGroupId",
    "emails"
  ]
}

---

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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userGroupId": {
      "type": "string",
      "description": "User Group Id"
    },
    "name": {
      "type": "string",
      "description": "The intended value to rename the user group to."
    }
  },
  "required": [
    "PCID",
    "userGroupId"
  ]
}