Method
createOrganizationGroup POST
Copy POST

Creates a new Organization Group.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes groupName str The name of the group.
Yes permissions List[str] The list of permissions to initialize the group with.
No defaultGroup bool If True, this group will replace the current default group.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result OrganizationGroup
KEY TYPE Description
organizationGroupId str The unique identifier of the Organization Group.
permissions List of Enum String The list of permissions (VIEW, MODIFY, ADMIN, BILLING, API_KEY, INVITE_USER) the group has.
groupName str The name of the Organization Group.
defaultGroup bool If true, all new users will be added to this group automatically.
admin bool If true, this group contains all permissions available to the organization and cannot be modified or deleted.
createdAt str When the Organization Group was created.

Exceptions:

TYPE WHEN
ConflictError

A group with this name already exists.
Language:

© Copyright