Skip to main content
POST
/
v3
/
sso-providers
Create an SSO provider
curl --request POST \
  --url https://api.ctrl-hub.com/v3/sso-providers \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "type": "oidc",
      "metadata": "<string>",
      "enforce": true
    },
    "relationships": {
      "organisation": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      },
      "default_role": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "type": "oidc",
      "name": "<string>",
      "metadata": "<string>",
      "enforce": true
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The SSO provider to create.

data
object
required

Response

Get a SSO provider.

JSON API response object

data
object
required

An SSO provider

jsonapi
object
required