All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| create_organization | POST /v2/orgs | Create Organization |
| delete_organization | DELETE /v2/orgs/{org_id} | Delete Organization |
| get_active_organization | GET /v2/orgs/active/org | Get Active Organization |
| get_organization | GET /v2/orgs/{org_id} | Get Organization |
| list_organizations | GET /v2/orgs | List Organizations |
| stats_organization | GET /v2/orgs/{org_id}/stats | Stats Organization |
| update_organization | PATCH /v2/orgs/{org_id} | Update Organization |
models::OrganizationReadWithApiKey create_organization(organization_create) Create Organization
Creates a new organization that will be owned by the authenticated actor (i.e: human team member or api key).
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| organization_create | OrganizationCreate | [required] |
models::OrganizationReadWithApiKey
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_organization(org_id) Delete Organization
Deletes an organization (Permit.io account) and all its related data.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| org_id | String | Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug"). | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::OrganizationRead get_active_organization() Get Active Organization
Gets a single organization (Permit.io account) matching the given org_id, if such org exists and can be accessed by the authenticated actor.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::OrganizationRead get_organization(org_id) Get Organization
Gets a single organization (Permit.io account) matching the given org_id, if such org exists and can be accessed by the authenticated actor.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| org_id | String | Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug"). | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::OrganizationRead list_organizations(page, per_page) List Organizations
Lists all the organizations that can be accessed by the authenticated actor (i.e: human team member or api key).
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| page | Option<i32> | Page number of the results to fetch, starting at 1. | [default to 1] | |
| per_page | Option<i32> | The number of results per page (max 100). | [default to 30] |
Vecmodels::OrganizationRead
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::OrganizationStats stats_organization(org_id) Stats Organization
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| org_id | String | Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug"). | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::OrganizationRead update_organization(org_id, organization_update) Update Organization
Updates the organization's profile.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| org_id | String | Either the unique id of the organization, or the URL-friendly key of the organization (i.e: the "slug"). | [required] | |
| organization_update | OrganizationUpdate | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]