Get organization by Auth ID
GET
/api/v1/organizations/active/{authId}
const url = 'https://localhost:10001/api/v1/organizations/active/example';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://localhost:10001/api/v1/organizations/active/example \ --header 'Authorization: <Authorization>'Retrieve a specific organization using an auth identifier
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” authId
required
string
Auth ID
Responses
Section titled “ Responses ”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"}