OrganizationsApi
| Method | HTTP request | Description |
|---|---|---|
| createOrganizationUsingPOST | POST /api/web/v1/organizations | Create an organization |
| createUserOrganizationAssociationUsingPOST | POST /api/web/v1/organizations/{orgid}/users/{userid} | Add user to organization |
| deleteUserOrganizationAssociationUsingDELETE | DELETE /api/web/v1/organizations/{orgid}/users/{userid} | Remove user from organization |
| getOrganizationUsingGET | GET /api/web/v1/organizations/{id} | Get an organization |
| organizationsPagedUsingPOST | POST /api/web/v1/organizationspaged | List a page of organizations |
| removeOrganizationUsingDELETE | DELETE /api/web/v1/organizations/{id} | Delete an organization |
| updateOrganizationUsingPUT | PUT /api/web/v1/organizations/{id} | Update an organization |
createOrganizationUsingPOST
Organization createOrganizationUsingPOST(organizationParms)
Create an organization
Create an organization. Caller requires the ORGANIZATIONS:ADD permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| organizationParms | 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 | - |
createUserOrganizationAssociationUsingPOST
createUserOrganizationAssociationUsingPOST(orgid, userid)
Add user to organization
Add user to organization. Caller requires the ORGANIZATIONS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| orgid | String | The UUID of the organization. | |
| userid | String | The UUID of the user to be added to the organization. |
Return type
null (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 | - |
deleteUserOrganizationAssociationUsingDELETE
deleteUserOrganizationAssociationUsingDELETE(orgid, userid)
Remove user from organization
Remove user from organization. Caller requires the ORGANIZATIONS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| orgid | String | The UUID of the organization. | |
| userid | String | The UUID of the user to be remove from the organization. |
Return type
null (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 | - |
getOrganizationUsingGET
Organization getOrganizationUsingGET(id)
Get an organization
Get the specified organization. Caller requires the ORGANIZATIONS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | 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 | - |
organizationsPagedUsingPOST
OrganizationPage organizationsPagedUsingPOST(searchParms)
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
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | 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 | - |
removeOrganizationUsingDELETE
removeOrganizationUsingDELETE(id)
Delete an organization
Delete the specified organization. Caller requires the ORGANIZATIONS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the organization to be removed. |
Return type
null (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 | - |
updateOrganizationUsingPUT
Organization updateOrganizationUsingPUT(id, organizationParms)
Update an organization
Update the specified organization. Caller requires the ORGANIZATIONS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the organization to be modified. | |
| organizationParms | 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 | - |