Skip to content
Governance Platform

Get organization by ID

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

Retrieve a specific organization by its ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
orgId
required
string

Organization ID or UUID (urn:uuid optional)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization

Media type application/json

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"
}

400

Section titled “400 ”

Bad request - Invalid organization ID

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"
}

401

Section titled “401 ”

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"
}

403

Section titled “403 ”

Forbidden - No organization access

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"
}

404

Section titled “404 ”

Organization not found

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"
}

500

Section titled “500 ”

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"
}