Skip to content

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

authId
required
string

Auth ID

Organization

Media type application/json
object
auth0Id

Deprecated: use IDPOrgID

string
createdAt
string
description
string
displayName
string
features
object
allowDemoDataUpload
boolean
id
integer
idpOrgId

Generic IDP organization ID

string
idpProvider

IDP provider name (auth0, keycloak, etc)

string
name
string
updatedAt
string
Example generated
{
"auth0Id": "example",
"createdAt": "example",
"description": "example",
"displayName": "example",
"features": {
"allowDemoDataUpload": true
},
"id": 1,
"idpOrgId": "example",
"idpProvider": "example",
"name": "example",
"updatedAt": "example"
}

Bad request - Invalid auth ID

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Organization not found

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Internal server error

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}