Organizations

Update Organization License Key

put

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.

Body

application/json

licenseKeystringOptional

Responses

204

No Content - License key successfully updated

400

Bad Request - Invalid JSON, empty license key, or validation failure of the license key

application/json

409

Conflict - License limit is incompatible with the current organization state

application/json

500

Internal Server Error - Failure in updating the license or unable to retrieve organization info from context

application/json

put

/organization-license

HTTPcURLJavaScriptPython

PUT /v1/organization-license HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "licenseKey": "text"
}

No content

Get organizations the user belongs to

get

Responses

200

OK - The organizations the user belongs to

application/json

500

Status Internal Server Error - Failed to retrieve organizations or other severe errors

application/json

get

/organizations

HTTPcURLJavaScriptPython

GET /v1/organizations HTTP/1.1
Host: 
Accept: */*

{
  "organizations": [
    {
      "apiVersion": "string",
      "breakglassUserID": "text",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "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": {}
    }
  ]
}

Insert a new organization and project

post

This endpoint allows creating a new organization along with a new project and establishes necessary bindings between them.

Body

application/json

Body of the request to insert a new organization

accountNamestringOptional

eulaAcceptedbooleanOptional

licenseTypestringOptional

organizationNamestringOptional

Responses

200

Contains the organization and project that was created

application/json

400

Bad Request - JSON parsing error or missing fields

application/json

404

Not Found - Failed to create organization or project

application/json

500

Internal Server Error - Failed to apply bindings or other server errors

application/json

post

/organizations

HTTPcURLJavaScriptPython

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"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "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",
    "breakglassUserID": "text",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "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": {}
  }
}

put

Body

application/json

createLicenseTypestringOptional

licenseKeystringOptional

Responses

204

No Content - License key successfully updated

400

Bad Request - Invalid JSON, empty license key, or validation failure of the license key

application/json

409

Conflict - License limit is incompatible with the current organization state

application/json

put

/organizations/:id/license

HTTPcURLJavaScriptPython

PUT /v1/organizations/:id/license HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "createLicenseType": "text",
  "licenseKey": "text"
}

No content

Get all projects associated with the organization by id

get

Responses

200

OK - Contains an array of projects associated with the organization

application/json

403

Status Forbidden - User does not have permission to retrieve projects

application/json

500

Status Internal Server Error - Failed to retrieve projects or other severe errors

application/json

get

/organizations/accounts

HTTPcURLJavaScriptPython

GET /v1/organizations/accounts HTTP/1.1
Host: 
Accept: */*

{
  "accounts": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "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": {}
    }
  ]
}

Get All Organizations and Projects

get

Returns all organizations and all projects in each organization that the user is a member of

Responses

200

OK - Contains all organizations and projects

application/json

401

Unauthorized - User does not have permission to get organizations and projects

application/json

500

Internal Server Error - Failed to get organizations and projects or other server errors

application/json

get

/organizations/accounts/all

HTTPcURLJavaScriptPython

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"
            },
            "blueprintTags": {
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "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",
        "breakglassUserID": "text",
        "kind": "string",
        "metadata": {
          "additionalInfo": {
            "documentation": [
              {
                "text": "text",
                "url": "text"
              }
            ],
            "message": "string"
          },
          "blueprintTags": {
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "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
    }
  ]
}

Get all projects associated with the organization by id

get

Responses

200

OK - Contains an array of projects associated with the organization

application/json

403

Status Forbidden - User does not have permission to retrieve projects

application/json

500

Status Internal Server Error - Failed to retrieve projects or other severe errors

application/json

get

/organizations/projects

HTTPcURLJavaScriptPython

GET /v1/organizations/projects HTTP/1.1
Host: 
Accept: */*

{
  "accounts": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "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": {}
    }
  ]
}

Get All Organizations and Projects

get

Returns all organizations and all projects in each organization that the user is a member of

Responses

200

OK - Contains all organizations and projects

application/json

401

Unauthorized - User does not have permission to get organizations and projects

application/json

500

Internal Server Error - Failed to get organizations and projects or other server errors

application/json

get

/organizations/projects/all

HTTPcURLJavaScriptPython

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"
            },
            "blueprintTags": {
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "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",
        "breakglassUserID": "text",
        "kind": "string",
        "metadata": {
          "additionalInfo": {
            "documentation": [
              {
                "text": "text",
                "url": "text"
              }
            ],
            "message": "string"
          },
          "blueprintTags": {
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "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
    }
  ]
}

Get all users associated with the organization by id

get

Responses

200

OK - Contains an array of users associated with the organization

application/json

403

Status Forbidden - User does not have permission to retrieve users

application/json

500

Status Internal Server Error - Failed to retrieve users or other severe errors

application/json

get

/organizations/users

HTTPcURLJavaScriptPython

GET /v1/organizations/users HTTP/1.1
Host: 
Accept: */*

{
  "users": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "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": {}
    }
  ]
}

Check Organization Display Name Usage

put

Verifies whether the provided display name for an organization is already used by any existing organization.

Body

application/json

Body of the request to verify an organization name

namestringOptional

The organization name to verify

Responses

200

OK - Contains a boolean indicating if the display name is in use

application/json

400

Bad Request - Invalid input or data types

application/json

500

Internal Server Error - Error processing the request

application/json

put

/organizations/verify

HTTPcURLJavaScriptPython

PUT /v1/organizations/verify HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "valid": true
}

Delete organization by id

delete

Path parameters

idstringRequired

the id of the organization to delete

Responses

204

Successful Delete, no content

403

Status Forbidden - User does not have permission to delete

application/json

500

Status Internal Server Error - Failed to delete organization or other severe errors

application/json

delete

/organizations/{id}

HTTPcURLJavaScriptPython

DELETE /v1/organizations/{id} HTTP/1.1
Host: 
Accept: */*

No content

Update Organization Display Name

patch

Updates the display name of the organization specified by the ID.

Path parameters

idstringRequired

The ID of the organization

Body

application/json

Body of the request to update organization metadata

namestringOptional

The updated organization name

Responses

200

OK - Display name updated successfully

No content

400

Bad Request - Invalid input, data types, or missing fields

application/json

401

Unauthorized - Authentication required or failed

application/json

404

Not Found - Organization not found

application/json

500

Internal Server Error - Error processing the request

application/json

patch

/organizations/{id}/metadata

HTTPcURLJavaScriptPython

PATCH /v1/organizations/{id}/metadata HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

Get organization by name

get

Path parameters

namestringRequired

the name of the organization to retrieve

Responses

200

OK - The organization requested by name

application/json

500

Status Internal Server Error - Failed to retrieve organization or other severe errors

application/json

get

/organizations/{name}

HTTPcURLJavaScriptPython

GET /v1/organizations/{name} HTTP/1.1
Host: 
Accept: */*

{
  "organization": {
    "apiVersion": "string",
    "breakglassUserID": "text",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "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": {}
  }
}