Credential Elicitation
Operations of the Connector Gateway API. Paths are relative to your deployment's API host.
POST /api/connector-gateway-api/credential-elicitations
Open a credential elicitation — the agent-safe way to ask a user for a secret
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json OpenCredentialElicitationDto
| Status | Description | Body |
|---|---|---|
| 201 | application/json CredentialElicitationOpenedDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/connector-gateway-api/credential-elicitations/{ref}
Read a credential elicitation — the ONLY thing an orchestrating agent learns
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ref | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json CredentialElicitationStatusDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/connector-gateway-api/credential-elicitations/{ref}/cancel
Cancel a pending credential elicitation
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ref | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json CredentialElicitationStatusDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/connector-gateway-api/credential-elicitations/{ref}/submit
Submit the filled credential form (browser only, with the subject user's own JWT)
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ref | path | string | yes |
Request body: application/json SubmitCredentialElicitationDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json CredentialElicitationSubmittedDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |