Skip to content

Add an external service

POST
/external-service
curl --request POST \
--url https://your-candig-domain/federation/v1/external-service \
--header 'Content-Type: application/json' \
--data '{ "service": "example", "authentication": { "issuer": "example", "token": "example" } }'

Add an external service

Media typeapplication/json
object
service
required

Name of the external service. Must be unique in the system.

string
authentication
required
object
issuer
required

Issuer associated with the OIDC token.

string
token
required

OIDC id_token issued to the service user from the issuer.

string
Examplegenerated
{
"service": "example",
"authentication": {
"issuer": "example",
"token": "example"
}
}

Service registered successfully

Service already registered

Authorization Error

Internal Error