Skip to content
AveraAveraAvera Documentation

Register an OIDC connection

POST
/api/v1/tenants/{tenantId}/identity/providers/oidc
curl --request POST \
  --url https://app.avera.io/api/v1/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/identity/providers/oidc \
  --header 'Content-Type: application/json' \
  --data '{ "issuer": "example", "clientId": "example", "clientSecret": "example", "displayName": "example", "allowedDomains": [ "example" ], "scopes": [ "example" ], "extraAuthorizationParams": "example", "requiredClaims": "example" }'

Creates a connection Avera federates itself, configured from an issuer and client credentials. Issuer, audience, allowed domains and required claims are enforced server-side.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
issuer
required
string
clientId
required
string
clientSecret
required
string
displayName
required
string
allowedDomains
required
Array<string>
scopes
Array<string> | null
extraAuthorizationParams
object | null
requiredClaims
object | null

Example generated

{
  "issuer": "example",
  "clientId": "example",
  "clientSecret": "example",
  "displayName": "example",
  "allowedDomains": [
    "example"
  ],
  "scopes": [
    "example"
  ],
  "extraAuthorizationParams": "example",
  "requiredClaims": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string format: uuid
tenantId
required
string format: uuid
connectionId
required
string
connectionType
required
string
displayName
required
string
allowedDomains
required
Array<string>
status
required
string
createdAt
required
string format: date-time
lastSyncAt
string | null format: date-time
lastTestedAt
string | null format: date-time
issuer
required
string
clientId
required
string
hasClientSecret
required
boolean
scopes
required
Array<string>
extraAuthorizationParams
required
object
key
additional properties
string
requiredClaims
required
object
key
additional properties
string