Credential types

Specifies paths and operations for managing ecosystem credential types.

Create credential type

Creates a new credential type in the requested ecosystem.

Analytic events

  • ECOSYSTEM_CREDENTIAL_CREATE_START
  • ECOSYSTEM_CREDENTIAL_CREATE_SUCCESS
  • ECOSYSTEM_CREDENTIAL_CREATE_FAIL
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
Request Body schema: application/json
required
Any of:
profile
required
string
Enum: "compact" "compact-semantic" "web-semantic"
type
required
string
name
required
string [ 1 .. 50 ] characters

The name of the credential

Responses
201

Credential type created

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

500

Internal Server Error. An unexpected error occurred.

post/v1/ecosystems/{ecosystemId}/credentials
Request samples
application/json
{
  • "profile": "compact",
  • "type": "DriverLicense",
  • "name": "Driver's License"
}
Response samples
application/json
{
  • "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
  • "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "profile": "compact",
  • "type": "DriverLicense",
  • "name": "Driver's License"
}

Retrieve credential types

Retrieves a list of credential types from the requested ecosystem.

Analytic events

  • ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_START
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_FAIL
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of returned list.

Example: limit=2
cursor
string

Starting point for the list of entries.

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Credential types retrieved

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

get/v1/ecosystems/{ecosystemId}/credentials
Request samples
Response samples
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}

Retrieve credential type

Retrieves a credential type from the requested ecosystem by its ID.

Analytic events

  • ECOSYSTEM_CREDENTIAL_RETRIEVE_START
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_SUCCESS
  • ECOSYSTEM_CREDENTIAL_RETRIEVE_FAIL
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
credentialId
required
string <uuid>

The UUID of the credential

Example: 599bf148-d711-405a-a20b-9c8a87ac8850
Responses
200

Credential type retrieved

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

get/v1/ecosystems/{ecosystemId}/credentials/{credentialId}
Request samples
Response samples
application/json
{
  • "id": "599bf148-d711-405a-a20b-9c8a87ac8850",
  • "ecosystemId": "87880d7e-a4d0-462e-8383-3f1e5e16865d",
  • "profile": "compact",
  • "type": "DriverLicense",
  • "name": "Driver's License"
}

Delete credential type

Deletes a credential type from the requested ecosystem by its ID.

Analytic events

  • ECOSYSTEM_CREDENTIAL_DELETE_START
  • ECOSYSTEM_CREDENTIAL_DELETE_SUCCESS
  • ECOSYSTEM_CREDENTIAL_DELETE_FAIL
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
credentialId
required
string <uuid>

The UUID of the credential

Example: 599bf148-d711-405a-a20b-9c8a87ac8850
Responses
204

Credential type deleted

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

delete/v1/ecosystems/{ecosystemId}/credentials/{credentialId}
Request samples
Response samples
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}