Create a Compact Semantic Credential Configuration
Creates a new Compact Semantic Credential configuration, a specific set of rules and parameters that are used to create and validate a particular type of verifiable credential. These rules and parameters define how the credential is structured and what data it contains when issued.
Analytic events
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL
Request Body schema: application/jsonrequired
The Credential Configuration payload
Credential configuration created
Bad Request
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "type": "CourseCredential",
- "claimMappings": {
- "firstName": {
- "mapFrom": "claims.given_name",
- "required": true
}, - "address": {
- "mapFrom": "claims.address.formatted"
}, - "providerSubjectId": {
- "mapFrom": "authenticationProvider.subjectId"
}
}, - "revocable": true,
- "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
- "expiresIn": {
- "years": 1,
- "months": 12,
- "weeks": 52,
- "days": 365,
- "hours": 24,
- "minutes": 1440,
- "seconds": 3600
}
}
- 201
- 400
{- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "type": "CourseCredential",
- "claimMappings": {
- "firstName": {
- "mapFrom": "claims.given_name",
- "required": true
}, - "address": {
- "mapFrom": "claims.address.formatted"
}, - "providerSubjectId": {
- "mapFrom": "authenticationProvider.subjectId"
}
}, - "revocable": true,
- "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
- "expiresIn": {
- "years": 1,
- "months": 12,
- "weeks": 52,
- "days": 365,
- "hours": 24,
- "minutes": 1440,
- "seconds": 3600
}
}
Retrieve all Compact Semantic Credential configurations
Returns a list of all Comapct Semantic Credential configurations from your tenant.
Analytic events
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL
query Parameters
Compact Semantic Credential configurations retrieved
Bad Request
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
- "data": [
- {
- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "type": "CourseCredential",
- "claimMappings": {
- "firstName": {
- "mapFrom": "claims.given_name",
- "required": true
}, - "address": {
- "mapFrom": "claims.address.formatted"
}, - "providerSubjectId": {
- "mapFrom": "authenticationProvider.subjectId"
}
}, - "revocable": true,
- "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
- "expiresIn": {
- "years": 1,
- "months": 12,
- "weeks": 52,
- "days": 365,
- "hours": 24,
- "minutes": 1440,
- "seconds": 3600
}
}
]
}
Retrieve a Compact Semantic Credential Configuration
Returns a Compact Semantic Credential Configuration by providing its ID.
Analytic events
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL
Compact Semantic Credential configuration retrieved
Bad Request
The Credential Configuration is not found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "type": "CourseCredential",
- "claimMappings": {
- "firstName": {
- "mapFrom": "claims.given_name",
- "required": true
}, - "address": {
- "mapFrom": "claims.address.formatted"
}, - "providerSubjectId": {
- "mapFrom": "authenticationProvider.subjectId"
}
}, - "revocable": true,
- "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
- "expiresIn": {
- "years": 1,
- "months": 12,
- "weeks": 52,
- "days": 365,
- "hours": 24,
- "minutes": 1440,
- "seconds": 3600
}
}
Update a Compact Semantic Credential configuration
Updates an existing Compact Semantic Credential configuration by providing its ID.
Analytic events
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL
path Parameters
Request Body schema: application/jsonrequired
Update a Credential Configuration
Compact Semantic Credential configuration updated
Bad Request
The Credential Configuration is not found
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "type": "CourseCredential",
- "claimMappings": {
- "firstName": {
- "mapFrom": "claims.given_name",
- "required": true
}, - "address": {
- "mapFrom": "claims.address.formatted"
}, - "providerSubjectId": {
- "mapFrom": "authenticationProvider.subjectId"
}
}, - "revocable": true,
- "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
- "expiresIn": {
- "years": 1,
- "months": 12,
- "weeks": 52,
- "days": 365,
- "hours": 24,
- "minutes": 1440,
- "seconds": 3600
}
}
- 200
- 400
- 404
{- "id": "983c0a86-204f-4431-9371-f5a22e506599",
- "type": "CourseCredential",
- "claimMappings": {
- "firstName": {
- "mapFrom": "claims.given_name",
- "required": true
}, - "address": {
- "mapFrom": "claims.address.formatted"
}, - "providerSubjectId": {
- "mapFrom": "authenticationProvider.subjectId"
}
}, - "revocable": true,
- "claimSourceId": "78e1b90c-401d-45bb-89c0-938da4d44c60",
- "expiresIn": {
- "years": 1,
- "months": 12,
- "weeks": 52,
- "days": 365,
- "hours": 24,
- "minutes": 1440,
- "seconds": 3600
}
}
Delete a Compact Semantic Credential configuration
Deletes an exising Compact Semantic Credential configuration by providing its ID.
Analytic events
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS
- CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL
Compact Semantic Credential configuration deleted
Bad Request
The Credential Configuration is not found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "BadRequest",
- "message": "Validation Error",
- "details": [
- {
- "location": "params",
- "msg": "Invalid value",
- "param": "id",
- "value": "abc"
}
]
}