Credentials

W3C Verifiable Credentials issued and managed within policies.

Get supported external service credential schemas.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/services

GET /api/v1/credentials/services HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Get user global credentials.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/user/global

GET /api/v1/credentials/user/global HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Set user global credential.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

put/credentials/user/global

PUT /api/v1/credentials/user/global HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Delete user global credential.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

serviceTypestringRequired

dryRunstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

delete/credentials/user/global

DELETE /api/v1/credentials/user/global?serviceType=text&dryRun=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Get user policy credentials.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/user/policy/{policyId}

GET /api/v1/credentials/user/policy/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Set user policy credential.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

put/credentials/user/policy/{policyId}

PUT /api/v1/credentials/user/policy/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Delete user policy credential.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Query parameters

serviceTypestringRequired

dryRunstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

delete/credentials/user/policy/{policyId}

DELETE /api/v1/credentials/user/policy/{policyId}?serviceType=text&dryRun=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Get SR global credentials visible to the current user (read-only).

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/user/sr-global

GET /api/v1/credentials/user/sr-global HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Get SR policy credentials visible to the current user (read-only).

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/user/sr-policy/{policyId}

GET /api/v1/credentials/user/sr-policy/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Get SR global credentials.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/sr/global

GET /api/v1/credentials/sr/global HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Set SR global credential.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

put/credentials/sr/global

PUT /api/v1/credentials/sr/global HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Delete SR global credential.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

serviceTypestringRequired

dryRunstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

delete/credentials/sr/global

DELETE /api/v1/credentials/sr/global?serviceType=text&dryRun=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Get SR policy credentials.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

get/credentials/sr/policy/{policyId}

GET /api/v1/credentials/sr/policy/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Set SR policy credential.

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

put/credentials/sr/policy/{policyId}

PUT /api/v1/credentials/sr/policy/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}

Delete SR policy credential.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

policyIdstringRequired

Query parameters

serviceTypestringRequired

dryRunstringRequired

Responses

401

Unauthorized request.

application/json

statusCodenumberRequiredExample: 401

messagestringRequiredExample: Unauthorized request

403

Forbidden

application/json

delete/credentials/sr/policy/{policyId}

DELETE /api/v1/credentials/sr/policy/{policyId}?serviceType=text&dryRun=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 401,
  "message": "Unauthorized request"
}