Organizations
Receives a new license key via JSON, decodes it, verifies its validity, and updates the organization's license in the system if it is valid.
No Content - License key successfully updated
No content
Bad Request - Invalid JSON, empty license key, or validation failure of the license key
Conflict - License limit is incompatible with the current organization state
Internal Server Error - Failure in updating the license or unable to retrieve organization info from context
PUT /v1/organization-license HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"licenseKey": "text"
}No content
OK - The organizations the user belongs to
Status Internal Server Error - Failed to retrieve organizations or other severe errors
GET /v1/organizations HTTP/1.1
Host:
Accept: */*
{
"organizations": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"auth0": {
"displayName": "text",
"id": "text",
"name": "text"
},
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
]
},
"status": {}
}
]
}This endpoint allows creating a new organization along with a new project and establishes necessary bindings between them.
Body of the request to insert a new organization
Contains the organization and project that was created
Bad Request - JSON parsing error or missing fields
Not Found - Failed to create organization or project
Internal Server Error - Failed to apply bindings or other server errors
POST /v1/organizations HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"accountName": "text",
"eulaAccepted": true,
"licenseType": "text",
"organizationName": "text"
}{
"account": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"alternateSecretKeys": [
"text"
],
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"secretKey": "text"
},
"status": {}
},
"organization": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"auth0": {
"displayName": "text",
"id": "text",
"name": "text"
},
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
]
},
"status": {}
}
}No Content - License key successfully updated
No content
Bad Request - Invalid JSON, empty license key, or validation failure of the license key
Conflict - License limit is incompatible with the current organization state
PUT /v1/organizations/:id/license HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"createLicenseType": "text",
"licenseKey": "text"
}No content
OK - Contains an array of projects associated with the organization
Status Forbidden - User does not have permission to retrieve projects
Status Internal Server Error - Failed to retrieve projects or other severe errors
GET /v1/organizations/accounts HTTP/1.1
Host:
Accept: */*
{
"accounts": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"alternateSecretKeys": [
"text"
],
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"secretKey": "text"
},
"status": {}
}
]
}Returns all organizations and all projects in each organization that the user is a member of
OK - Contains all organizations and projects
Unauthorized - User does not have permission to get organizations and projects
Internal Server Error - Failed to get organizations and projects or other server errors
GET /v1/organizations/accounts/all HTTP/1.1
Host:
Accept: */*
{
"activeAccountId": "text",
"organizationAccounts": [
{
"accounts": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"alternateSecretKeys": [
"text"
],
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"secretKey": "text"
},
"status": {}
}
],
"organization": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"auth0": {
"displayName": "text",
"id": "text",
"name": "text"
},
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
]
},
"status": {}
},
"ssoEnabled": true
}
]
}OK - Contains an array of projects associated with the organization
Status Forbidden - User does not have permission to retrieve projects
Status Internal Server Error - Failed to retrieve projects or other severe errors
GET /v1/organizations/projects HTTP/1.1
Host:
Accept: */*
{
"accounts": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"alternateSecretKeys": [
"text"
],
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"secretKey": "text"
},
"status": {}
}
]
}Returns all organizations and all projects in each organization that the user is a member of
OK - Contains all organizations and projects
Unauthorized - User does not have permission to get organizations and projects
Internal Server Error - Failed to get organizations and projects or other server errors
GET /v1/organizations/projects/all HTTP/1.1
Host:
Accept: */*
{
"activeAccountId": "text",
"organizationAccounts": [
{
"accounts": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"alternateSecretKeys": [
"text"
],
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
],
"secretKey": "text"
},
"status": {}
}
],
"organization": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"auth0": {
"displayName": "text",
"id": "text",
"name": "text"
},
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
]
},
"status": {}
},
"ssoEnabled": true
}
]
}OK - Contains an array of users associated with the organization
Status Forbidden - User does not have permission to retrieve users
Status Internal Server Error - Failed to retrieve users or other severe errors
GET /v1/organizations/users HTTP/1.1
Host:
Accept: */*
{
"users": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"activeAccount": "text",
"email": "text",
"nextLoginAccount": "text",
"requestedMFA": true
},
"status": {}
}
]
}Verifies whether the provided display name for an organization is already used by any existing organization.
Body of the request to verify an organization name
The organization name to verify
OK - Contains a boolean indicating if the display name is in use
Bad Request - Invalid input or data types
Internal Server Error - Error processing the request
PUT /v1/organizations/verify HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}{
"valid": true
}the id of the organization to delete
Successful Delete, no content
No content
Status Forbidden - User does not have permission to delete
Status Internal Server Error - Failed to delete organization or other severe errors
DELETE /v1/organizations/{id} HTTP/1.1
Host:
Accept: */*
No content
Updates the display name of the organization specified by the ID.
The ID of the organization
Body of the request to update organization metadata
The updated organization name
OK - Display name updated successfully
No content
Bad Request - Invalid input, data types, or missing fields
Unauthorized - Authentication required or failed
Not Found - Organization not found
Internal Server Error - Error processing the request
PATCH /v1/organizations/{id}/metadata HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}No content
the name of the organization to retrieve
OK - The organization requested by name
Status Internal Server Error - Failed to retrieve organization or other severe errors
GET /v1/organizations/{name} HTTP/1.1
Host:
Accept: */*
{
"organization": {
"apiVersion": "string",
"kind": "string",
"metadata": {
"additionalInfo": {
"documentation": [
{
"text": "text",
"url": "text"
}
],
"message": "string"
},
"dateModified": "text",
"deprecated": true,
"description": "string",
"displayName": "string",
"hash": "text",
"icon": "string",
"id": "string",
"labels": {},
"name": "string",
"resourceDocLink": "string",
"stability": "string",
"version": 1,
"warning": "string"
},
"spec": {
"auth0": {
"displayName": "text",
"id": "text",
"name": "text"
},
"parameters": [
{
"credential": true,
"name": "text",
"sensitive": true,
"value": null
}
]
},
"status": {}
}
}Was this helpful?