Orgs
UpdateOrganization
/api/v1/orgs/{org_id}UpdateOrganization updates organization details
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer |
GetOrganizationAnalytics
/api/v1/orgs/{org_id}/analyticsGetOrganizationAnalytics returns analytics for an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer |
ListAPIKeysHandler
/api/v1/orgs/{org_id}/api-keysListAPIKeysHandler handles GET /api/v1/api-keys
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 500 | Internal Server Error |
CreateAPIKeyHandler
/api/v1/orgs/{org_id}/api-keysCreateAPIKeyHandler handles POST /api/v1/api-keys
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 500 | Internal Server Error |
DeleteAPIKeyHandler
/api/v1/orgs/{org_id}/api-keys/{id}DeleteAPIKeyHandler handles DELETE /api/v1/api-keys/:id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
RevokeAPIKeyHandler
/api/v1/orgs/{org_id}/api-keys/{id}/revokeRevokeAPIKeyHandler handles POST /api/v1/api-keys/:id/revoke
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
DeleteDiscordConfig
/api/v1/orgs/{org_id}/discord-configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GetDiscordConfig
/api/v1/orgs/{org_id}/discord-configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
UpdateDiscordConfig
/api/v1/orgs/{org_id}/discord-configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GetOrganizationMembers
/api/v1/orgs/{org_id}/membersGetOrganizationMembers returns members of an organization with pagination
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer | |
| page | query | Yes | string | |
| limit | query | Yes | string |
ChangeUserRole
/api/v1/orgs/{org_id}/members/{user_id}/roleChangeUserRole changes a user’s role in an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer | |
| user_id | path | Yes | integer |
DeleteSlackConfig
/api/v1/orgs/{org_id}/slack-configDeleteSlackConfig removes the org’s slack bot configuration.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer |
Responses
| Code | Description |
|---|---|
| 204 | No Content |
GetSlackConfig
/api/v1/orgs/{org_id}/slack-configGetSlackConfig returns the org’s slack bot configuration (without secrets).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer |
Responses
| Code | Description |
|---|---|
| 200 | OK |
PutSlackConfig
/api/v1/orgs/{org_id}/slack-configPutSlackConfig creates or updates the org’s slack bot configuration.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer |
Responses
| Code | Description |
|---|---|
| 200 | OK |
DeleteTeamsConfig
/api/v1/orgs/{org_id}/teams-configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GetTeamsConfig
/api/v1/orgs/{org_id}/teams-configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
UpdateTeamsConfig
/api/v1/orgs/{org_id}/teams-configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GetOrganizationMembers
/api/v1/orgs/{org_id}/usersGetOrganizationMembers returns members of an organization with pagination
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer | |
| page | query | Yes | string | |
| limit | query | Yes | string |
CreateUser
/api/v1/orgs/{org_id}/usersCreateUser handles creating a new user in an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 201 | Created |
DeactivateUser
/api/v1/orgs/{org_id}/users/{user_id}DeactivateUser handles deactivating a user in an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| user_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GetUser
/api/v1/orgs/{org_id}/users/{user_id}GetUser handles getting a specific user in an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| user_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
UpdateUser
/api/v1/orgs/{org_id}/users/{user_id}UpdateUser handles updating a user in an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| user_id | path | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GetUserAuditLog
/api/v1/orgs/{org_id}/users/{user_id}/audit-logGetUserAuditLog handles getting the audit log for a user
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| user_id | path | Yes | string | |
| offset | query | Yes | string | |
| limit | query | Yes | string |
ForcePasswordReset
/api/v1/orgs/{org_id}/users/{user_id}/force-password-resetForcePasswordReset forces a user to reset their password on next login
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| user_id | path | Yes | string |
ChangeUserRole
/api/v1/orgs/{org_id}/users/{user_id}/roleChangeUserRole changes a user’s role in an organization
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | integer | |
| user_id | path | Yes | integer |
CheckUser
/api/v1/orgs/{org_id}/users/checkCheckUser handles checking if a user exists by email
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| org_id | path | Yes | string | |
| query | Yes | string |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 500 | Internal Server Error |