List organizations

Returns a list of organizations that the user is a member of. If an email address is provided in the query this allows a user with sufficient privilege to check if a given user is a member of any organizations.

GET /api/v1/organizations

List organizations

cURL

curl --request GET \
  --url https://identity.nks.europe-west4.nscale.com/api/v1/organizations \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "metadata": {
      "id": "a142f641-7fd6-4ab9-a875-344c7ebadc53",
      "name": "acme-corp",
      "creationTime": "2024-05-31T14:11:00Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "organizationType": "domain",
      "domain": "acme.corp",
      "providerID": "b6ec241d-e3b4-4afc-a7aa-500fcb650d8e"
    }
  }
]

Authorizations

Authorization · string · header · required

Operation requires OAuth 2.0 bearer token authentication.

Query Parameters

email · string

A user's email address.

Response

200

application/json

A list of organizations.

metadata · object · required

Metadata required by all resource reads.

Show child attributes

spec · object · required

An organization.

Show child attributes