Get organization by Auth ID

GET

/api/v1/organizations/active/{authId}

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

Retrieve a specific organization using an auth identifier

Authorizations

• BearerAuth

Parameters

Path Parameters

authId

required

string

Auth ID

Responses

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

Bad request - Invalid auth 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

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

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

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