OrganizationsApi
| Method | HTTP request | Description |
|---|---|---|
| create_organization_using_post | POST /api/web/v1/organizations | Create an organization |
| create_user_organization_association_using_post | POST /api/web/v1/organizations/{orgid}/users/{userid} | Add user to organization |
| delete_user_organization_association_using_delete | DELETE /api/web/v1/organizations/{orgid}/users/{userid} | Remove user from organization |
| get_organization_using_get | GET /api/web/v1/organizations/{id} | Get an organization |
| organizations_paged_using_post | POST /api/web/v1/organizationspaged | List a page of organizations |
| remove_organization_using_delete | DELETE /api/web/v1/organizations/{id} | Delete an organization |
| update_organization_using_put | PUT /api/web/v1/organizations/{id} | Update an organization |
create_organization_using_post
Organization create_organization_using_post(organization_parms)
Create an organization
Create an organization. Caller requires the ORGANIZATIONS:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| organization_parms | OrganizationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
create_user_organization_association_using_post
create_user_organization_association_using_post(orgid, userid)
Add user to organization
Add user to organization. Caller requires the ORGANIZATIONS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| orgid | str | The UUID of the organization. | |
| userid | str | The UUID of the user to be added to the organization. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
delete_user_organization_association_using_delete
delete_user_organization_association_using_delete(orgid, userid)
Remove user from organization
Remove user from organization. Caller requires the ORGANIZATIONS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| orgid | str | The UUID of the organization. | |
| userid | str | The UUID of the user to be remove from the organization. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_organization_using_get
Organization get_organization_using_get(id)
Get an organization
Get the specified organization. Caller requires the ORGANIZATIONS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the organization to be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
organizations_paged_using_post
OrganizationPage organizations_paged_using_post(search_parms)
List a page of organizations
Returns organizations for the provided search parameters. Caller requires the ORGANIZATIONS:VIEW permission. The following searchByAttributes are supported:
- displayName: a string value that indicates the display name of the organizations. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
- name: a string value that indicates the name of the organizations. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
If you provide more than one search attribute, they are joined with an AND condition.
The orderByAttribute supports these attribute names: displayName, name.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
remove_organization_using_delete
remove_organization_using_delete(id)
Delete an organization
Delete the specified organization. Caller requires the ORGANIZATIONS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the organization to be removed. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
update_organization_using_put
Organization update_organization_using_put(id, organization_parms)
Update an organization
Update the specified organization. Caller requires the ORGANIZATIONS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the organization to be modified. | |
| organization_parms | OrganizationParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |