ReferenceSDKClient
Identity Federation
SDK reference for identity federation — Register and manage external identity providers for OIDC federation.
Register and manage external identity providers for OIDC federation.
list
List the OIDC identity providers registered for the active organization.
GET
Usage:
const result = await swirls.client.idp.list()Output:
| Field | Type | Description |
|---|---|---|
providers | object[] |
register
Register an identity provider for the active organization. Activates on the first successful token exchange.
POST
Usage:
const result = await swirls.client.idp.register({
provider: '...',
instanceIdentifier: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
provider | "clerk" | "supabase" | Yes | |
instanceIdentifier | string | Yes | |
subjectClaim | string | No |
Output:
| Field | Type | Description |
|---|---|---|
id | string | |
provider | string | |
instanceIdentifier | string | |
issuer | string | |
audience | string | |
subjectClaim | string | |
status | "pending" | "active" | |
createdAt | string |
remove
Remove an identity provider from the active organization.
POST
Usage:
const result = await swirls.client.idp.remove({
id: '...',
})Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes |
Output:
| Field | Type | Description |
|---|---|---|
removed | true |