Skip to content
Governance Platform

Create organization

POST
/api/v1/organizations
 
curl --request POST \
  --url https://localhost:10001/api/v1/organizations \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "auth0Id": "example", "description": "example", "displayName": "example", "idpOrgId": "example", "idpProvider": "example", "name": "example" }'

Create a new organization and add the creating user as organization owner

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”

Organization payload

Media type application/json
object
auth0Id

Deprecated: use idpOrgId

string
description
string
displayName
string
idpOrgId

Generic IDP organization ID

string
idpProvider

IDP provider name (auth0, keycloak, etc)

string
name
required
string
Example generated
{
  "auth0Id": "example",
  "description": "example",
  "displayName": "example",
  "idpOrgId": "example",
  "idpProvider": "example",
  "name": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created 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 request body

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 - Insufficient permissions

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