Get organization by ID

GET

/api/v1/organizations/{orgId}

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

Retrieve a specific organization by its ID

Authorizations

• BearerAuth

Parameters

Path Parameters

orgId

required

integer

Organization ID

Responses

200

Organization

Media type application/json

object

auth0Id

Deprecated: use IDPOrgID

string

createdAt

string

description

string

displayName

string

id

integer

idpOrgId

Generic IDP organization ID

string

idpProvider

IDP provider name (auth0, keycloak, etc)

string

name

string

updatedAt

string

uuid

string

Example ^generated

{
  "auth0Id": "example",
  "createdAt": "example",
  "description": "example",
  "displayName": "example",
  "id": 1,
  "idpOrgId": "example",
  "idpProvider": "example",
  "name": "example",
  "updatedAt": "example",
  "uuid": "example"
}

400

Bad request - Invalid organization ID

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

401

Unauthorized - Authentication required

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

403

Forbidden - No organization access

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

404

Organization not found

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

500

Internal server error

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}