mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 12:27:45 +00:00
13 lines
5.1 KiB
Markdown
13 lines
5.1 KiB
Markdown
# CreateOrganizationRequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `name` | *String* | :heavy_check_mark: | The name of the new organization |
|
|
| `createdBy` | *String* | :heavy_check_mark: | The ID of the User who will become the administrator for the new organization |
|
|
| `privateMetadata` | [Optional<? extends com.clerk.backend_api.models.operations.CreateOrganizationPrivateMetadata>](../../models/operations/CreateOrganizationPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, accessible only from the Backend API |
|
|
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.operations.CreateOrganizationPublicMetadata>](../../models/operations/CreateOrganizationPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API |
|
|
| `slug` | *Optional<? extends String>* | :heavy_minus_sign: | A slug for the new organization.<br/>Can contain only lowercase alphanumeric characters and the dash "-".<br/>Must be unique for the instance. |
|
|
| `maxAllowedMemberships` | *Optional<? extends Long>* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | |