/ 
OpenAPI-Client-OpenAI-0.28
⭐ Starred 7 / OpenAPI::Client::OpenAI::Path::organization-groups

NAME

OpenAPI::Client::OpenAI::Path::organization-groups - Documentation for the /organization/groups path.

OPERATIONS

GET /organization/groups

list-groups

$client->list_groups({
    body => { ... },
});

Lists all groups in the organization.

Path/query parameters

  • limit (in query, optional, integer) - A limit on the number of groups to be returned. Limit can range between 0 and 1000, and the default is 100.

    Default: 100

  • after (in query, optional, string) - A cursor for use in pagination. after is a group ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with group_abc, your subsequent call can include after=group_abc in order to fetch the next page of the list.

  • order (in query, optional, string) - Specifies the sort order of the returned groups.

    Allowed values: asc, desc

    Default: asc

Responses

200 - Groups listed successfully.

Content-Type: application/json

Example:

{
   "data" : [
      {
         "created_at" : 1711471533,
         "id" : "group_01J1F8ABCDXYZ",
         "is_scim_managed" : false,
         "name" : "Support Team"
      },
      {
         "created_at" : 1711472599,
         "id" : "group_01J1F8PQRMNO",
         "is_scim_managed" : true,
         "name" : "Sales"
      }
   ],
   "has_more" : false,
   "next" : null,
   "object" : "list"
}

POST /organization/groups

create-group

$client->create_group({
    body => { ... },
});

Creates a new group in the organization.

Responses

200 - Group created successfully.

Content-Type: application/json

Example:

{
   "created_at" : 1711471533,
   "group_type" : "group",
   "id" : "group_01J1F8ABCDXYZ",
   "is_scim_managed" : false,
   "name" : "Support Team"
}

SCHEMAS

CreateGroupBody

Properties:

  • name (string, required) - Human readable name for the group.

GroupListResource

Properties:

  • data (array of GroupResponse, required) - Groups returned in the current page.

  • has_more (boolean, required) - Whether additional groups are available when paginating.

  • next (anyOf, required) - Cursor to fetch the next page of results, or null if there are no more results.

  • object (string, required) - Always list .

    Allowed values: list

GroupResponse

Properties:

  • created_at (integer, required) - Unix timestamp (in seconds) when the group was created.

  • group_type (string, required) - The type of the group.

    Allowed values: group, tenant_group

  • id (string, required) - Identifier for the group.

  • is_scim_managed (boolean, required) - Whether the group is managed through SCIM and controlled by your identity provider.

  • name (string, required) - Display name of the group.

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.