Skip to content

List all organizations

GET
/api/v1/organizations
curl --request GET \
--url https://localhost:10001/api/v1/organizations \
--header 'Authorization: <Authorization>'

Retrieve a list of all organizations

Organizations

Media type application/json
Array<object>

A company or top-level entity that owns projects and the policy library

object
auth0Id

Deprecated: use idpOrgId

string
createdAt
string format: date-time
description
string
displayName
string
id
integer
idpOrgId

Generic IDP organization ID

string
idpProvider

IDP provider name (auth0, keycloak, etc)

string
name
string
updatedAt
string format: date-time
uuid

Urn:uuid form

string
Example generated
[
{
"auth0Id": "example",
"description": "example",
"displayName": "example",
"idpOrgId": "example",
"idpProvider": "example",
"name": "example"
}
]

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example
{
"error": "Invalid request body"
}