organizations
API for working with organizations.
📄️ Get organization information
Provide organization information. ### Authority - `ADMINISTRATOR` - `MANAGER` - `MEMBER`
📄️ Update organization
> **Enterprise edition feature** > > Available only if an Organization plugin is enabled. Update organization information with the provided data. ### Authority - `ADMINISTRATOR` - `MANAGER`
📄️ Delete organization
> **Enterprise edition feature** > > Available only if an Organization plugin is enabled. Delete organization by identifier. ### Authority - `ADMINISTRATOR`
📄️ Patch organization
Partial update organization information. Model supports only organization users update. | Path | Operation | Value |- |- |- | `/users/-`| `add` | `object{id:int,org_role:string}` | `/users` | `replace` | `array<object{id:int,org_role:string}>`, `array<null>` | `/users` | `remove` | `array<object{id:int}>`, `null` ### Authority - `ADMINISTRATOR` - `MANAGER`</object{id:int}></null></object{id:int,org_role:string}>
📄️ Get organization settings
Get organization settings. ### Authority - `ADMINISTRATOR` - `MANAGER` - `MEMBER`
📄️ Update organization settings
> **Important**: Values for `logs.period` and `attachments.period` cannot exceed the value of `launches.period`. Update organization settings. ### Authority - `ADMINISTRATOR` - `MANAGER`
📄️ Get a list of organizations
Get a list of existing organizations. ### Authority - `ADMINISTRATOR` - `MANAGER` - `MEMBER` ### Access level - `ADMINISTRATOR` - `MANAGER` : limited to viewing only their assigned organizations. - `MEMBER` : limited to viewing only their assigned organizations.
📄️ Create a new organization
> **Enterprise edition feature** Create a new organization. Provide name and slug. ### Authority - `ADMINISTRATOR`
📄️ Create search request for organizations
Create search request for organizations by provided criteria. You can use the following attributes as a `search_criteria[*].filter_key` for filtering: - `name` - filter by organization name. - `slug` - filter by organization slug. - `type` - filter by organization type. - `created_at` - filter by creation date. - `updated_at` - filter by last update date. ### CSV Export Use text/csv for the Accept header to export organizations. ### Authority - `ADMINISTRATOR`