WorkOS PHP SDK

Groups
in package

Application

Properties

$client : HttpClient

Methods

__construct() : mixed
createGroupOrganizationMembership() : Group: Add a member to a Group
createOrganizationGroup() : Group: Create a group
deleteGroupOrganizationMembership() : void: Remove a member from a Group
deleteOrganizationGroup() : void: Delete a group
getOrganizationGroup() : Group: Get a group
listGroupOrganizationMemberships() : PaginatedResponse<string|int, UserOrganizationMembershipBaseListData>: List Group members
listOrganizationGroups() : PaginatedResponse<string|int, Group>: List groups
updateOrganizationGroup() : Group: Update a group

$client read-only


        private
            HttpClient
    $client

__construct()


    public
                    __construct(HttpClient $client) : mixed

Parameters

$client : HttpClient

createGroupOrganizationMembership()

Add a member to a Group


    public
                    createGroupOrganizationMembership(string $organizationId, string $groupId, string $organizationMembershipId[, RequestOptions|null $options = null ]) : Group

Add an organization membership to a group.

Parameters

$organizationId : string: Unique identifier of the Organization.
$groupId : string: Unique identifier of the Group.
$organizationMembershipId : string: The ID of the Organization Membership to add to the group.
$options : RequestOptions|null = null

Return values

Group

createOrganizationGroup()

Create a group


    public
                    createOrganizationGroup(string $organizationId, string $name[, string|null $description = null ][, RequestOptions|null $options = null ]) : Group

Create a new group within an organization.

Parameters

$organizationId : string: The ID of the organization.
$name : string: The name of the Group.
$description : string|null = null: An optional description of the Group.
$options : RequestOptions|null = null

Return values

Group

deleteGroupOrganizationMembership()

Remove a member from a Group


    public
                    deleteGroupOrganizationMembership(string $organizationId, string $groupId, string $omId[, RequestOptions|null $options = null ]) : void

Remove an organization membership from a group.

Parameters

$organizationId : string: Unique identifier of the Organization.
$groupId : string: Unique identifier of the Group.
$omId : string: Unique identifier of the Organization Membership.
$options : RequestOptions|null = null

deleteOrganizationGroup()

Delete a group


    public
                    deleteOrganizationGroup(string $organizationId, string $groupId[, RequestOptions|null $options = null ]) : void

Delete a group from an organization.

Parameters

$organizationId : string: The ID of the organization.
$groupId : string: The ID of the group.
$options : RequestOptions|null = null

getOrganizationGroup()

Get a group


    public
                    getOrganizationGroup(string $organizationId, string $groupId[, RequestOptions|null $options = null ]) : Group

Retrieve a group by its ID within an organization.

Parameters

$organizationId : string: The ID of the organization.
$groupId : string: The ID of the group.
$options : RequestOptions|null = null

Return values

Group

listGroupOrganizationMemberships()

List Group members


    public
                    listGroupOrganizationMemberships(string $organizationId, string $groupId[, string|null $before = null ][, string|null $after = null ][, int|null $limit = null ][, EventsOrder $order = EventsOrder::Desc ][, RequestOptions|null $options = null ]) : PaginatedResponse<string|int, UserOrganizationMembershipBaseListData>

Get a list of organization memberships in a group.

Parameters

$organizationId : string: Unique identifier of the Organization.
$groupId : string: Unique identifier of the Group.
$before : string|null = null: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with "obj_123", your subsequent call can include before="obj_123" to fetch a new batch of objects before "obj_123".
$after : string|null = null: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with "obj_123", your subsequent call can include after="obj_123" to fetch a new batch of objects after "obj_123".
$limit : int|null = null: Upper limit on the number of objects to return, between 1 and 100. Defaults to 10.
$order : EventsOrder = EventsOrder::Desc: Order the results by the creation time. Supported values are "asc" (ascending), "desc" (descending), and "normal" (descending with reversed cursor semantics where before fetches older records and after fetches newer records). Defaults to descending. Defaults to "desc".
$options : RequestOptions|null = null

Return values

PaginatedResponse<string|int, UserOrganizationMembershipBaseListData>

listOrganizationGroups()

List groups


    public
                    listOrganizationGroups(string $organizationId[, string|null $before = null ][, string|null $after = null ][, int|null $limit = null ][, EventsOrder $order = EventsOrder::Desc ][, RequestOptions|null $options = null ]) : PaginatedResponse<string|int, Group>

Get a paginated list of groups within an organization.

Parameters

$organizationId : string: The ID of the organization.
$before : string|null = null: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with "obj_123", your subsequent call can include before="obj_123" to fetch a new batch of objects before "obj_123".
$after : string|null = null: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with "obj_123", your subsequent call can include after="obj_123" to fetch a new batch of objects after "obj_123".
$limit : int|null = null: Upper limit on the number of objects to return, between 1 and 100. Defaults to 10.
$order : EventsOrder = EventsOrder::Desc: Order the results by the creation time. Supported values are "asc" (ascending), "desc" (descending), and "normal" (descending with reversed cursor semantics where before fetches older records and after fetches newer records). Defaults to descending. Defaults to "desc".
$options : RequestOptions|null = null

Return values

PaginatedResponse<string|int, Group>

updateOrganizationGroup()

Update a group


    public
                    updateOrganizationGroup(string $organizationId, string $groupId[, string|null $name = null ][, string|null $description = null ][, RequestOptions|null $options = null ]) : Group

Update an existing group. Only the fields provided in the request body will be updated.

Parameters

$organizationId : string: The ID of the organization.
$groupId : string: The ID of the group.
$name : string|null = null: The name of the Group.
$description : string|null = null: An optional description of the Group.
$options : RequestOptions|null = null

Return values

Group

Groups in package Application

Table of Contents

Properties

Methods

Properties

$client read-only

Methods

__construct()

Parameters

createGroupOrganizationMembership()

Parameters

Tags

Return values

createOrganizationGroup()

Parameters

Tags

Return values

deleteGroupOrganizationMembership()

Parameters

Tags

deleteOrganizationGroup()

Parameters

Tags

getOrganizationGroup()

Parameters

Tags

Return values

listGroupOrganizationMemberships()

Parameters

Tags

Return values

listOrganizationGroups()

Parameters

Tags

Return values

updateOrganizationGroup()

Parameters

Tags

Return values

Groups
in package

Application