---
title: "Create tenant authentication connection"
description: "Creates an OIDC, SAML, LDAP, or social sign-in connection through the existing audited identity service. The submitted secret is write-only and is sealed by the identity service. Requires an idempotency key.\n\n### Quire permissions\n\nRequired capability: `auth/configure`.\n\nCredential scopes: `tenants:write`.\n\nThe acting subject must also be allowed to perform this action in the organisation."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API › tenants

`POST /tenant_auth_connections`

Creates an OIDC, SAML, LDAP, or social sign-in connection through the existing audited identity service. The submitted secret is write-only and is sealed by the identity service. Requires an idempotency key.

\### Quire permissions

Required capability: `auth/configure`.

Credential scopes: `tenants:write`.

The acting subject must also be allowed to perform this action in the organisation.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`, scopes: `tenants:write`
- `oauth2`, oauth2, scopes: `tenants:write`

## Header parameters

- `createTenantAuthConnection.header.Idempotency-Key` (string, required) — A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with `Idempotency-Replayed: true`. Reusing a key for a different request is refused.
  - maxLength 255
- `createTenantAuthConnection.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.
  - format `date`

## Request body

_Required._

- `createTenantAuthConnection.protocol` (string, required)
  - one of `"oidc"`, `"saml"`, `"ldap"`, `"social"`
- `createTenantAuthConnection.provider_key` (string, required)
  - minLength 1; maxLength 63
- `createTenantAuthConnection.display_name` (string, required)
  - minLength 1; maxLength 200
- `createTenantAuthConnection.issuer` (string, required)
  - maxLength 2000
- `createTenantAuthConnection.client_id` (string, optional)
  - maxLength 500
- `createTenantAuthConnection.secret` (string, optional) — Write-only provider secret. An empty or omitted value keeps the stored secret on update.
  - maxLength 4000
- `createTenantAuthConnection.domains` (array<string>, optional)
  - maxLength 253
- `createTenantAuthConnection.settings` (map<unknown>, optional)
- `createTenantAuthConnection.attribute_mapping` (map<unknown>, optional)
- `createTenantAuthConnection.role_mapping` (map<string>, optional)
- `createTenantAuthConnection.accepted_acr_values` (array<string>, optional)
  - minLength 1; maxLength 300
- `createTenantAuthConnection.jit_provisioning` (boolean, optional)
- `createTenantAuthConnection.idp_initiated` (boolean, optional)
- `createTenantAuthConnection.enabled` (boolean, optional)

## Example request

```json
{
  "protocol": "oidc",
  "provider_key": "string",
  "display_name": "string",
  "issuer": "string",
  "client_id": "string",
  "secret": "string",
  "domains": [
    "string"
  ],
  "settings": {
    "property1": null,
    "property2": null
  },
  "attribute_mapping": {
    "property1": null,
    "property2": null
  },
  "role_mapping": {
    "property1": "string",
    "property2": "string"
  },
  "accepted_acr_values": [
    "string"
  ],
  "jit_provisioning": true,
  "idp_initiated": true,
  "enabled": true
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://your-organisation.quirelms.com/api/v1/tenant_auth_connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: string' \
  --data '
{
  "protocol": "oidc",
  "provider_key": "string",
  "display_name": "string",
  "issuer": "string",
  "client_id": "string",
  "secret": "string",
  "domains": [
    "string"
  ],
  "settings": {
    "property1": null,
    "property2": null
  },
  "attribute_mapping": {
    "property1": null,
    "property2": null
  },
  "role_mapping": {
    "property1": "string",
    "property2": "string"
  },
  "accepted_acr_values": [
    "string"
  ],
  "jit_provisioning": true,
  "idp_initiated": true,
  "enabled": true
}
'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/tenant_auth_connections';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Idempotency-Key': 'string',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    protocol: 'oidc',
    provider_key: 'string',
    display_name: 'string',
    issuer: 'string',
    client_id: 'string',
    secret: 'string',
    domains: ['string'],
    settings: {property1: null, property2: null},
    attribute_mapping: {property1: null, property2: null},
    role_mapping: {property1: 'string', property2: 'string'},
    accepted_acr_values: ['string'],
    jit_provisioning: true,
    idp_initiated: true,
    enabled: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://your-organisation.quirelms.com/api/v1/tenant_auth_connections"

payload = {
    "protocol": "oidc",
    "provider_key": "string",
    "display_name": "string",
    "issuer": "string",
    "client_id": "string",
    "secret": "string",
    "domains": ["string"],
    "settings": {
        "property1": None,
        "property2": None
    },
    "attribute_mapping": {
        "property1": None,
        "property2": None
    },
    "role_mapping": {
        "property1": "string",
        "property2": "string"
    },
    "accepted_acr_values": ["string"],
    "jit_provisioning": True,
    "idp_initiated": True,
    "enabled": True
}
headers = {
    "Content-Type": "application/json",
    "Idempotency-Key": "string",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

Success.

#### Example

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "protocol": "oidc",
  "provider_key": "string",
  "display_name": "string",
  "issuer": "string",
  "client_id": "string",
  "secret_configured": true,
  "domains": [
    "string"
  ],
  "settings": {
    "property1": null,
    "property2": null
  },
  "attribute_mapping": {
    "property1": null,
    "property2": null
  },
  "role_mapping": {
    "property1": "string",
    "property2": "string"
  },
  "accepted_acr_values": [
    "string"
  ],
  "jit_provisioning": true,
  "idp_initiated": true,
  "enabled": true,
  "certificate_expires_at": "2019-08-24T14:15:22Z",
  "last_synced_at": "2019-08-24T14:15:22Z",
  "registration": {
    "property1": "string",
    "property2": "string"
  }
}
```

- `createTenantAuthConnection.response.201.id` (string, required)
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `createTenantAuthConnection.response.201.protocol` (string, required)
  - one of `"oidc"`, `"saml"`, `"ldap"`, `"social"`
- `createTenantAuthConnection.response.201.provider_key` (string, required)
- `createTenantAuthConnection.response.201.display_name` (string, required)
- `createTenantAuthConnection.response.201.issuer` (string, required)
- `createTenantAuthConnection.response.201.client_id` (string | null, required)
- `createTenantAuthConnection.response.201.secret_configured` (boolean, required)
- `createTenantAuthConnection.response.201.domains` (array<string>, required)
- `createTenantAuthConnection.response.201.settings` (map<unknown>, required)
- `createTenantAuthConnection.response.201.attribute_mapping` (map<unknown>, required)
- `createTenantAuthConnection.response.201.role_mapping` (map<string>, required)
- `createTenantAuthConnection.response.201.accepted_acr_values` (array<string>, required)
- `createTenantAuthConnection.response.201.jit_provisioning` (boolean, required)
- `createTenantAuthConnection.response.201.idp_initiated` (boolean, required)
- `createTenantAuthConnection.response.201.enabled` (boolean, required)
- `createTenantAuthConnection.response.201.certificate_expires_at` (any of, required)
  - any of: `string`, `null`
- `createTenantAuthConnection.response.201.last_synced_at` (any of, required)
  - any of: `string`, `null`
- `createTenantAuthConnection.response.201.registration` (map<string>, required)

### 401

The credential is missing, malformed, expired or revoked.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createTenantAuthConnection.response.401.type` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.401.title` (string, required)
- `createTenantAuthConnection.response.401.status` (integer, required)
- `createTenantAuthConnection.response.401.code` (string, required)
- `createTenantAuthConnection.response.401.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createTenantAuthConnection.response.401.detail` (string, required)
- `createTenantAuthConnection.response.401.request_id` (string, required)
- `createTenantAuthConnection.response.401.docs_url` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.401.errors` (array<object>, optional)
  - `createTenantAuthConnection.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createTenantAuthConnection.response.401.errors.code` (string, required)
  - `createTenantAuthConnection.response.401.errors.detail` (string, required)
- `createTenantAuthConnection.response.401.retry_after` (integer | null, optional)

### 403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createTenantAuthConnection.response.403.type` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.403.title` (string, required)
- `createTenantAuthConnection.response.403.status` (integer, required)
- `createTenantAuthConnection.response.403.code` (string, required)
- `createTenantAuthConnection.response.403.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createTenantAuthConnection.response.403.detail` (string, required)
- `createTenantAuthConnection.response.403.request_id` (string, required)
- `createTenantAuthConnection.response.403.docs_url` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.403.errors` (array<object>, optional)
  - `createTenantAuthConnection.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createTenantAuthConnection.response.403.errors.code` (string, required)
  - `createTenantAuthConnection.response.403.errors.detail` (string, required)
- `createTenantAuthConnection.response.403.retry_after` (integer | null, optional)

### 409

The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createTenantAuthConnection.response.409.type` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.409.title` (string, required)
- `createTenantAuthConnection.response.409.status` (integer, required)
- `createTenantAuthConnection.response.409.code` (string, required)
- `createTenantAuthConnection.response.409.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createTenantAuthConnection.response.409.detail` (string, required)
- `createTenantAuthConnection.response.409.request_id` (string, required)
- `createTenantAuthConnection.response.409.docs_url` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.409.errors` (array<object>, optional)
  - `createTenantAuthConnection.response.409.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createTenantAuthConnection.response.409.errors.code` (string, required)
  - `createTenantAuthConnection.response.409.errors.detail` (string, required)
- `createTenantAuthConnection.response.409.retry_after` (integer | null, optional)

### 422

The request was understood and its content is not valid. `errors` names each field.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createTenantAuthConnection.response.422.type` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.422.title` (string, required)
- `createTenantAuthConnection.response.422.status` (integer, required)
- `createTenantAuthConnection.response.422.code` (string, required)
- `createTenantAuthConnection.response.422.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createTenantAuthConnection.response.422.detail` (string, required)
- `createTenantAuthConnection.response.422.request_id` (string, required)
- `createTenantAuthConnection.response.422.docs_url` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.422.errors` (array<object>, optional)
  - `createTenantAuthConnection.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createTenantAuthConnection.response.422.errors.code` (string, required)
  - `createTenantAuthConnection.response.422.errors.detail` (string, required)
- `createTenantAuthConnection.response.422.retry_after` (integer | null, optional)

### 429

A rate limit or a concurrency cap was reached. `Retry-After` says when to try again.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createTenantAuthConnection.response.429.type` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.429.title` (string, required)
- `createTenantAuthConnection.response.429.status` (integer, required)
- `createTenantAuthConnection.response.429.code` (string, required)
- `createTenantAuthConnection.response.429.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createTenantAuthConnection.response.429.detail` (string, required)
- `createTenantAuthConnection.response.429.request_id` (string, required)
- `createTenantAuthConnection.response.429.docs_url` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.429.errors` (array<object>, optional)
  - `createTenantAuthConnection.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createTenantAuthConnection.response.429.errors.code` (string, required)
  - `createTenantAuthConnection.response.429.errors.detail` (string, required)
- `createTenantAuthConnection.response.429.retry_after` (integer | null, optional)

### 500

Something failed at our end. Quote `request_id` when reporting it.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createTenantAuthConnection.response.500.type` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.500.title` (string, required)
- `createTenantAuthConnection.response.500.status` (integer, required)
- `createTenantAuthConnection.response.500.code` (string, required)
- `createTenantAuthConnection.response.500.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createTenantAuthConnection.response.500.detail` (string, required)
- `createTenantAuthConnection.response.500.request_id` (string, required)
- `createTenantAuthConnection.response.500.docs_url` (string, required)
  - format `uri`
- `createTenantAuthConnection.response.500.errors` (array<object>, optional)
  - `createTenantAuthConnection.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createTenantAuthConnection.response.500.errors.code` (string, required)
  - `createTenantAuthConnection.response.500.errors.detail` (string, required)
- `createTenantAuthConnection.response.500.retry_after` (integer | null, optional)


Source: https://docs.quirelms.com/api/tenants/createTenantAuthConnection/index.md