diff --git a/postman/README.md b/postman/README.md index 08e996db..8834674f 100644 --- a/postman/README.md +++ b/postman/README.md @@ -1,6 +1,6 @@ # MATTR VII Postman Collection -Postman is a collaboration platform for API development. This postman collection provides a simple interface to use MATTR VII API. Its categorised endpoints, sample request body and pre-request scripts make it easier and quicker to interact with your tenant. +Postman is a collaboration platform for API development. This postman collection provides a simple interface to use MATTR VII API. Its categorized endpoints, sample request body and pre-request scripts make it easier and quicker to interact with your tenant. ## Getting started @@ -11,19 +11,19 @@ Visit the Postman [downloads page](https://www.postman.com/downloads/) to instal ### Step 2: Download collection and environment files Save the following files locally: -- [`Platform API Collection`](./platform-v9.0.0-postman-collection.json): This Postman Collection includes API operations and some configuration. -- [`Tenant Environment`](./mattr-vii.postman_environment.json): This Postman Environment Variables hold specific values for your MATTR VII tenant. +- [`Platform API Collection`](./platform-v12.1.0-postman-collection.json): This Postman Collection includes API operations and some configuration. +- [`Tenant Environment`](./mattr-vii.postman_environment.json): This file defines variables for your MATTR VII tenant. You will need to update it with your own tenant variables later. ### Step 3: Import collection and environment files into Postman 1. Open Postman. 2. Select the **Import** button in the _My Workspace_ area. -3. Select the local versions of the [_Tenant Environment_](./mattr-vii.postman_environment.json) and the [_Platform API Collection_](./platform-v9.0.0-postman-collection.json) files you saved earlier. +3. Select the local versions of the _Tenant Environment_ and the _Platform API Collection_ files you downloaded in the previous step. ### Step 4: Update environment variables -1. Select the **Enviornments** button in the _My Workspace_ sidebar. -2. Select the _MATTR VII Tenant (Example ENV)_ environment from your environments list. +1. Select the **Environments** button in the _My Workspace_ sidebar. +2. Select the _MATTR VII Tenant_ environment from your environments list. 3. Update the following variables with your tenant details: - `baseUrl`: Replace with your tenant's URL. - `auth0Base`: Replace with your Authentication server URL. @@ -32,26 +32,14 @@ Save the following files locally: - `tenantAudience`: Replace with your tenant's URL. 4. Select the `Save` button. -If you are unsure of any of these details, please [contact us](http://mattr.globa/contact-us). +If you are unsure of any of these details, please [contact us](mailto:dev-support@mattr.global). ### Step 5: Try it out 1. Select the Collections button in the _My Workspace_ sidebar. 2. Select the MATTR VII API collection. -3. Select the Retrieve a list of DIDs endpoint (You can find it under _Tenant configuration > DIDs_). +3. Select the _Retrieve all IACAs_ endpoint (You can find it under _Tenant configuration > Identifiers > IACA_). 4. Select **Send** in the top right corner of the request pane. -5. The response should be displayed in the _Response_ pane. - -### Management API - -To use the Management API collection, repeat steps 2-4 with the following adjustments: - -1. In step 2, download the [Management API collection](./management-v1.11.0-postman-collection.json) file. -2. In step 3, import the [Management API collection](./management-v1.11.0-postman-collection.json) file. -3. In step 4, change the following variables: - - `baseUrl`: Replace with `https://manage.mattr.global`. - - `auth0Base`: Replace with `https://auth.manage.mattr.global`. - - `tenantClientId`: Replace with your Client ID for the Management API. - - `tenantClientSecret`: Replace with your Client Secret for the Management API. +5. The response should be displayed in the _Response_ pane (If this is a new tenant, the response is likely to be empty).

Copyright © MATTR Limited. Some rights reserved.
“MATTR” is a trademark of MATTR Limited, registered in New Zealand and other countries.

diff --git a/postman/management-v1.11.0-postman-collection.json b/postman/management-v1.11.0-postman-collection.json deleted file mode 100644 index 01157630..00000000 --- a/postman/management-v1.11.0-postman-collection.json +++ /dev/null @@ -1,2597 +0,0 @@ -{ - "info": { - "_postman_id": "384a4aac-dbb3-442f-9c33-1aa6e3aa7f14", - "name": "Management API (v1.11.0)", - "description": "# Introduction\nThe Management API offers a set of actions beyond the scope of a single tenant or environment. An environment is a higher-order structure where MATTR VII tenants are hosted in a specific MATTR VII cloud deployment. One tenant must always be a part of exactly one environment. Each environment may include multiple tenants that share hardware resources and environment settings while maintaining authorization and data isolation.\n\nYou can currently use the Management API to create, delete and list tenants, and also to list your environments.\n\n# Pagination\nMost list operations in the API use pagination that can be controlled by a cursor method using the `cursor` and `limit` query parameters.\n\n**Example on [Retrieve List of Credentials](#operation/retrieveListCreds)**\n```\nGET https://manage.mattr.global/v1/tenants\n?limit=100\n&cursor=Y3JlYXRlZEF0PTIwMjAtMTAtMDhUMjMlM0ExMyUzQTE3Ljg5NtZGUxZWEyNzQ4MWI4\n```\n\n* The `nextCursor` is found at the start of each returned range of credential entries and identifies the last object in the list.\n* The `limit` determines how many entries are returned in that request, with a maximum value of 1000.\n\nRequesting a page after the last value in the list will return an empty `data` object.\n\n``` json\n{\n\"data\": []\n}\n```\n\nNot using a query parameter defaults the response to return the first range of credential entries with a limit of 100.\n\n# Authorization\nThe Management API is a separate set of APIs to MATTR VII. It uses machine-to-machine authentication through its own credentials, which are different from your MATTR VII client credentials.\n\nAs part of onboarding you will be provided with the required details to make a call to a dedicated management API authorization provider and receive a bearer token.\n\nThis token is then used in an `authorization` header on all calls identified as requiring `bearerAuth` (this is required for the majority of management operations).\n\n\n\n\nContact Support:\n Email: support@mattr.global", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "28262321" - }, - "item": [ - { - "name": "Environments", - "item": [ - { - "name": "Retrieve environments", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/environments?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "environments" - ], - "query": [ - { - "key": "limit", - "value": "2", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "description": "Starting point for the list of entries." - } - ] - }, - "description": "Retrieves a list of all available environments.\n\n### **Analytic events**\n* ENVIRONMENT_RETRIEVE_LIST_START\n* ENVIRONMENT_RETRIEVE_LIST_SUCCESS\n* ENVIRONMENT_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "A list of environments", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/environments?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "environments" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"fa605282-0223-4ae0-831d-af368bc39a55\",\n \"domain\": \"vii.au01.mattr.global\",\n \"authorizationServerDomain\": \"manage.auth.auth0.com\",\n \"deploymentModel\": \"public\",\n \"region\": {\n \"id\": \"70bb433a-f0ec-4297-ad76-3b09c71311f3\",\n \"name\": \"AU01\",\n \"displayName\": \"Sydney, Australia\"\n },\n \"name\": \"MATTR Public Sydney, Australia\"\n },\n {\n \"id\": \"fa605282-0223-4ae0-831d-af368bc39a55\",\n \"domain\": \"vii.au01.mattr.global\",\n \"authorizationServerDomain\": \"manage.auth.auth0.com\",\n \"deploymentModel\": \"public\",\n \"region\": {\n \"id\": \"70bb433a-f0ec-4297-ad76-3b09c71311f3\",\n \"name\": \"AU01\",\n \"displayName\": \"Sydney, Australia\"\n },\n \"name\": \"MATTR Public Sydney, Australia\"\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/environments?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "environments" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/environments?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "environments" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/environments?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "environments" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/environments?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "environments" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ] - }, - { - "name": "Tenants", - "item": [ - { - "name": "Retrieve tenants", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ], - "query": [ - { - "key": "limit", - "value": "2", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "description": "Starting point for the list of entries." - } - ] - }, - "description": "Retrieves a list of all available tenants. If you haven't created any tenants, the response will include an empty array.\n\n### **Analytic events**\n* TENANT_RETRIEVE_LIST_START\n* TENANT_RETRIEVE_LIST_SUCCESS\n* TENANT_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "A list of tenants", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"86cb97a9-5e80-4ed7-af13-a170752bb1ea\",\n \"name\": \"My Tenant\",\n \"subdomain\": \"my-tenant.vii.au01.mattr.global\",\n \"environment\": {\n \"id\": \"fa605282-0223-4ae0-831d-af368bc39a55\",\n \"domain\": \"vii.au01.mattr.global\",\n \"authorizationServerDomain\": \"manage.auth.auth0.com\",\n \"deploymentModel\": \"public\",\n \"region\": {\n \"id\": \"70bb433a-f0ec-4297-ad76-3b09c71311f3\",\n \"name\": \"AU01\",\n \"displayName\": \"Sydney, Australia\"\n },\n \"name\": \"MATTR Public Sydney, Australia\"\n }\n },\n {\n \"id\": \"86cb97a9-5e80-4ed7-af13-a170752bb1ea\",\n \"name\": \"My Tenant\",\n \"subdomain\": \"my-tenant.vii.au01.mattr.global\",\n \"environment\": {\n \"id\": \"fa605282-0223-4ae0-831d-af368bc39a55\",\n \"domain\": \"vii.au01.mattr.global\",\n \"authorizationServerDomain\": \"manage.auth.auth0.com\",\n \"deploymentModel\": \"public\",\n \"region\": {\n \"id\": \"70bb433a-f0ec-4297-ad76-3b09c71311f3\",\n \"name\": \"AU01\",\n \"displayName\": \"Sydney, Australia\"\n },\n \"name\": \"MATTR Public Sydney, Australia\"\n }\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Create tenant", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - }, - "description": "Creates a new tenant in the requested environment.\n\n### **Analytic events**\n* TENANT_CREATE_START\n* TENANT_CREATE_SUCCESS\n* TENANT_CREATE_FAIL" - }, - "response": [ - { - "name": "Tenant created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"client\": {\n \"clientId\": \"suC7IhmDIawnlqBlEOuIqBWoqppcdI5\",\n \"clientSecret\": \"Qn_43J-SPeAPExeewH6YLn1rjVOCPsR_6_4lSmeUF-GSNuVAwdrBiGqerKUl8YZg\",\n \"name\": \"Example client\",\n \"permissions\": [\n \"dids:read\",\n \"dids:create\"\n ],\n \"roles\": [\n \"issuer\"\n ]\n },\n \"id\": \"86cb97a9-5e80-4ed7-af13-a170752bb1ea\",\n \"name\": \"My Tenant\",\n \"subdomain\": \"my-tenant.vii.au01.mattr.global\",\n \"environment\": {\n \"id\": \"fa605282-0223-4ae0-831d-af368bc39a55\",\n \"domain\": \"vii.au01.mattr.global\",\n \"authorizationServerDomain\": \"manage.auth.auth0.com\",\n \"deploymentModel\": \"public\",\n \"region\": {\n \"id\": \"70bb433a-f0ec-4297-ad76-3b09c71311f3\",\n \"name\": \"AU01\",\n \"displayName\": \"Sydney, Australia\"\n },\n \"name\": \"MATTR Public Sydney, Australia\"\n },\n \"permissions\": [\n \"dids:create\",\n \"dids:read\"\n ]\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Service Unavailable. The server is temporarily unavailable to handle requests.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"subdomain\": \"my-tenant\",\n \"environmentId\": \"84ca6f53-5405-4413-a6ad-848b781807e7\",\n \"name\": \"My Tenant\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants" - ] - } - }, - "status": "Service Unavailable", - "code": 503, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Retrieve tenant", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - }, - "description": "Retrieves a tenant by its ID.\n\n### **Analytic events**\n* TENANT_RETRIEVE_START\n* TENANT_RETRIEVE_SUCCESS\n* TENANT_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Tenant retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"86cb97a9-5e80-4ed7-af13-a170752bb1ea\",\n \"name\": \"My Tenant\",\n \"subdomain\": \"my-tenant.vii.au01.mattr.global\",\n \"environment\": {\n \"id\": \"fa605282-0223-4ae0-831d-af368bc39a55\",\n \"domain\": \"vii.au01.mattr.global\",\n \"authorizationServerDomain\": \"manage.auth.auth0.com\",\n \"deploymentModel\": \"public\",\n \"region\": {\n \"id\": \"70bb433a-f0ec-4297-ad76-3b09c71311f3\",\n \"name\": \"AU01\",\n \"displayName\": \"Sydney, Australia\"\n },\n \"name\": \"MATTR Public Sydney, Australia\"\n },\n \"permissions\": [\n \"dids:create\",\n \"dids:read\"\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"cupidatat enim\",\n \"type\": \"dolor\",\n \"message\": \"proident laborum in\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Delete tenant", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - }, - "description": "Deletes a tenant by its ID.\n\n### **Analytic events**\n* TENANT_DELETE_START\n* TENANT_DELETE_SUCCESS\n* TENANT_DELETE_FAIL" - }, - "response": [ - { - "name": "Tenant deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"cupidatat enim\",\n \"type\": \"dolor\",\n \"message\": \"proident laborum in\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to delete." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ] - }, - { - "name": "Clients", - "item": [ - { - "name": "Retrieve clients", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - }, - "description": "Retrieves a list of clients authorized to interact with the requested tenant.\n\n### **Analytic events**\n* TENANT_CLIENT_RETRIEVE_LIST_START\n* TENANT_CLIENT_RETRIEVE_LIST_SUCCESS\n* TENANT_CLIENT_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Clients retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n \"suC7IhmDIawnlqBlEOuIqBWoqppcdI5\",\n \"suC7IhmDIawnlqBlEOuIqBWoqppcdI5\"\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"cupidatat enim\",\n \"type\": \"dolor\",\n \"message\": \"proident laborum in\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "2" - }, - { - "key": "cursor", - "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" - } - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to retrieve clients for." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Create a client", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Example client\",\n \"roles\": [\n \"issuer\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to create a client for." - } - ] - }, - "description": "Creates a new client for the requested tenant.\n\n### **Analytic events**\n* TENANT_CLIENT_CREATE_START\n* TENANT_CLIENT_CREATE_SUCCESS\n* TENANT_CLIENT_CREATE_FAIL" - }, - "response": [ - { - "name": "Client created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Example client\",\n \"roles\": [\n \"issuer\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to create a client for." - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"clientId\": \"suC7IhmDIawnlqBlEOuIqBWoqppcdI5\",\n \"clientSecret\": \"Qn_43J-SPeAPExeewH6YLn1rjVOCPsR_6_4lSmeUF-GSNuVAwdrBiGqerKUl8YZg\",\n \"name\": \"Example client\",\n \"permissions\": [\n \"dids:read\",\n \"dids:create\"\n ],\n \"roles\": [\n \"issuer\"\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Example client\",\n \"roles\": [\n \"issuer\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to create a client for." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Example client\",\n \"roles\": [\n \"issuer\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to create a client for." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"cupidatat enim\",\n \"type\": \"dolor\",\n \"message\": \"proident laborum in\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Example client\",\n \"roles\": [\n \"issuer\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to create a client for." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Service Unavailable. The server is temporarily unavailable to handle requests.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"Example client\",\n \"roles\": [\n \"issuer\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Unique ID of the tenant to create a client for." - } - ] - } - }, - "status": "Service Unavailable", - "code": 503, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Delete a client", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients/:clientId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Identifier of the tenant to delete the client from." - }, - { - "key": "clientId", - "value": "irure ut dolornisi estdolore ali", - "description": "(Required) Identifier of the client to delete." - } - ] - }, - "description": "Deletes an existing client of the specified tenant.\n\n### **Analytic events**\n* TENANT_CLIENT_DELETE_START\n* TENANT_CLIENT_DELETE_SUCCESS\n* TENANT_CLIENT_DELETE_FAIL" - }, - "response": [ - { - "name": "Client deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients/:clientId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Identifier of the tenant to delete the client from." - }, - { - "key": "clientId", - "value": "irure ut dolornisi estdolore ali", - "description": "(Required) Identifier of the client to delete." - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients/:clientId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Identifier of the tenant to delete the client from." - }, - { - "key": "clientId", - "value": "irure ut dolornisi estdolore ali", - "description": "(Required) Identifier of the client to delete." - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"qui deserunt ullamco in\",\n \"type\": \"amet dolor\",\n \"message\": \"eu laboris id\",\n \"details\": [\n {\n \"value\": \"Duis esse et minim\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"quis fugiat\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients/:clientId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Identifier of the tenant to delete the client from." - }, - { - "key": "clientId", - "value": "irure ut dolornisi estdolore ali", - "description": "(Required) Identifier of the client to delete." - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"cupidatat enim\",\n \"type\": \"dolor\",\n \"message\": \"proident laborum in\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients/:clientId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Identifier of the tenant to delete the client from." - }, - { - "key": "clientId", - "value": "irure ut dolornisi estdolore ali", - "description": "(Required) Identifier of the client to delete." - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Service Unavailable. The server is temporarily unavailable to handle requests.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/tenants/:tenantId/clients/:clientId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "v1", - "tenants", - ":tenantId", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "tenantId", - "value": "urn:uuid:4c650379-7fad-20d2-76b8-9d1705feb5ab", - "description": "(Required) Identifier of the tenant to delete the client from." - }, - { - "key": "clientId", - "value": "irure ut dolornisi estdolore ali", - "description": "(Required) Identifier of the client to delete." - } - ] - } - }, - "status": "Service Unavailable", - "code": 503, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ] - }, - { - "name": "Security", - "item": [ - { - "name": "Create API Auth Token", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"client_id\": \"htf792W4p4MedZbnoWAs51EfqUt4d2\",\n \"client_secret\": \"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G\",\n \"audience\": \"https://my-tenant.vii.mattr.global\",\n \"grant_type\": \"client_credentials\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{oauth-token-Url}}/oauth/token", - "host": [ - "{{oauth-token-Url}}" - ], - "path": [ - "oauth", - "token" - ] - }, - "description": "Returns an API access token specific to the Management API. This token must then be used as an authorization header for all requests to protected endpoints (this is required for the majority of operations)." - }, - "response": [ - { - "name": "Successful response", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"client_id\": \"htf792W4p4MedZbnoWAs51EfqUt4d2\",\n \"client_secret\": \"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G\",\n \"audience\": \"https://my-tenant.vii.mattr.global\",\n \"grant_type\": \"client_credentials\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{oauth-token-Url}}/oauth/token", - "host": [ - "{{oauth-token-Url}}" - ], - "path": [ - "oauth", - "token" - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"access_token\": \"s2dgbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6s2dcaEROemRDf5gbRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\"\n}" - }, - { - "name": "Unauthorized", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"client_id\": \"htf792W4p4MedZbnoWAs51EfqUt4d2\",\n \"client_secret\": \"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G\",\n \"audience\": \"https://my-tenant.vii.mattr.global\",\n \"grant_type\": \"client_credentials\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{oauth-token-Url}}/oauth/token", - "host": [ - "{{oauth-token-Url}}" - ], - "path": [ - "oauth", - "token" - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"error\": \"access_denied\",\n \"error_description\": \"Unauthorized\"\n}" - } - ] - } - ] - } - ], - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}", - "type": "string" - } - ] - }, - "variable": [ - { - "key": "baseUrl", - "value": "https://manage.mattr.global", - "type": "string" - }, - { - "key": "oauth-token-Url", - "value": "https://auth.manage.mattr.global", - "type": "string" - } - ] -} \ No newline at end of file diff --git a/postman/platform-v12.1.0-postman-collection.json b/postman/platform-v12.1.0-postman-collection.json new file mode 100644 index 00000000..e63f5ffc --- /dev/null +++ b/postman/platform-v12.1.0-postman-collection.json @@ -0,0 +1,54074 @@ +{ + "info": { + "_postman_id": "e6fabb48-e8fd-42a3-b266-19d4d151f401", + "name": "MATTR VII Platform API (v12.1.0)", + "description": "# Introduction\nThe MATTR VII API defines a set of capabilities that can be used to manage and interact with a MATTR VII tenant. This includes managing a Verifiable Credential across its lifecycle (issue-hold-verify) as well as various tenant administration and management tasks such as setting up a custom domain, creating identifiers and configuring issuance and verification workflows.\n\n# Getting Started with our APIs\nAs a MATTR VII user, you are provided with the following details, required for accessing and engaging with your MATTR VII tenant:\n\n``` json\n{\n \"audience\": \"YOUR_AUDIENCE_URL\",\n \"auth_url\": \"YOUR_AUTH_URL\",\n \"tenant_url\": \"YOUR_TENANT_URL\",\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\"\n}\n```\n\n1. Use the `auth_url`, `audience`, `client_id` and `client_secret` to [obtain an access token](https://learn.mattr.global/api-reference/latest/tag/Security#operation/authToken).\n2. To make a request to your tenant, suffix the `tenant_url` with the endpoint route and include the obtained access token as a header bearer token. For example:\n\n```\nGET https://{tenant_url}/v1/dids\n```\n\n# Pagination\nMost list operations in the API enable cursor pagination using the `cursor` and `limit` query parameters:\n\n**Example on [Retrieve List of Credentials](#operation/retrieveListCreds)**\n```\nGET https://{tenant-url}/v2/credentials\n?limit=100\n&cursor=Y3JlYXRlZEF0PTIwMjAtMTAtMDhUMjMlM0ExMyUzQTE3Ljg5NtZGUxZWEyNzQ4MWI4\n```\n\n* `limit`: determines how many entries are returned in that request, with a maximum value of 1000.\n* `cursor`: sets the location in the retrieved list to get the next batch of entries from. This is based on the returned `nextCursor`, found at the beginning of each returned range and identifies the last object in the list.\n\nRequesting an entry after the last list value will return an empty `data` object:\n\n``` json\n{\n\"data\": []\n}\n```\n\nNot providing a query parameter defaults the response to return the first range of entries with a `limit` of 100.\n\n# Authorization\nAccess to the API is granted by our authorization provider. Use the `auth_url`, `audience`, `client_id` and `client_secret` provided with your tenant details to [make a request](https://learn.mattr.global/api-reference/latest/tag/Security#operation/authToken) to receive a bearer token from the auth provider. This token must then be used as an `authorization` header for all requests to protected endpoints (this is required for the majority of operations).\n\n> The returned bearer token will only enable access to endpoints as per your client's defined role. Refer to [Access Control](#access-control) for more information.\n\n\n\n# Access control\n\nMATTR VII uses **Role-Based Access Control (RBAC)** to manage permissions and access within a tenant. Each role grants access to specific capabilities, ensuring that users or clients only have access to the functionalities they need. Below is a list of available roles and their descriptions:\n\n- Tenant admin: Has full access to all tenant capabilities. This role is\n assigned to the default client when a new tenant is created.\n- Issuer: Has access to capabilities required for issuing and managing\n credentials of different formats across different channels.\n- Verifier: Has access to capabilities required for verifying credentials\n of different formats across different channels.\n- DTS provider: Has access to capabilities required for managing a\n Digital trust service (DTS).\n- DTS consumer: Has access to capabilities required to consume DTS\n information from a tenant.\n- Auditor: Has read-only access to analytics data.\n\nEach restricted endpoint includes a Roles property that indicates what roles are required to access it.\n\n\nContact Support:\n Email: dev-support@mattr.global", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "28262321" + }, + "item": [ + { + "name": "General", + "item": [ + { + "name": "Analytics", + "item": [ + { + "name": "Retrieve events", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&dateFrom=2023-06-01T02:45:44.087Z&dateTo=2023-06-30T23:59:59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "events" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + }, + { + "key": "dateFrom", + "value": "2023-06-01T02:45:44.087Z", + "description": "Query by event start date and time (inclusive), in ISO-8601 format." + }, + { + "key": "dateTo", + "value": "2023-06-30T23:59:59.999Z", + "description": "Query by event end date and time (inclusive), in ISO-8601 format." + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3", + "description": "Filter events by management user IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified management user IDs.\n\nSpecial filtering values:\n- `none`: Returns events that are not assigned to any management user IDs. \n- `*`: Returns events that are assigned to any management user IDs.\n" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3", + "description": "Filter events by management user IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified management user IDs.\n\nSpecial filtering values:\n- `none`: Returns events that are not assigned to any management user IDs. \n- `*`: Returns events that are assigned to any management user IDs.\n" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "description": "Filter events by client IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified client IDs.\n\nSpecial filtering values:\n- `none`: Returns events that are not assigned to any client IDs. \n- `*`: Returns events that are assigned to any client IDs.\n" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "description": "Filter events by client IDs. You can obtain these IDs from the event details. The response will include all individual events associated with the specified client IDs.\n\nSpecial filtering values:\n- `none`: Returns events that are not assigned to any client IDs. \n- `*`: Returns events that are assigned to any client IDs.\n" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of matching events from the tenant's event database. \n\nThe `categories` and `types` parameters filter based on an **OR** logic, whilst all other parameters use an \"AND\" logic. For example `(categories OR types) AND requestIds AND dateFrom`.\n\nRefer to the [Events registry](https://api-reference-sdk.mattr.global/event-registry/latest/index.html) for an inclusive list of events categories and types.\n" + }, + "response": [ + { + "name": "A list of events", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&dateFrom=2023-06-01T02:45:44.087Z&dateTo=2023-06-30T23:59:59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "events" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "dateFrom", + "value": "2023-06-01T02:45:44.087Z" + }, + { + "key": "dateTo", + "value": "2023-06-30T23:59:59.999Z" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"type\": \"CREDENTIAL_COMPACT_SIGN_START\",\n \"timestamp\": \"2023-06-01T02:45:44.087Z\",\n \"category\": \"credential-compact\",\n \"metadata\": {},\n \"data\": {},\n \"requestId\": \"4SO6JZz3sPYLjOQvxIVHr5\",\n \"managementUserId\": \"ea691ed4-90ff-4be2-bd85-f2c74efa72c3\",\n \"clientId\": \"54rp8Z8yGnlva19mThj7tJzNXFSyXrCf\"\n },\n {\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"type\": \"CREDENTIAL_COMPACT_SIGN_START\",\n \"timestamp\": \"2023-06-01T02:45:44.087Z\",\n \"category\": \"credential-compact\",\n \"metadata\": {},\n \"data\": {},\n \"requestId\": \"4SO6JZz3sPYLjOQvxIVHr5\",\n \"managementUserId\": \"ea691ed4-90ff-4be2-bd85-f2c74efa72c3\",\n \"clientId\": \"54rp8Z8yGnlva19mThj7tJzNXFSyXrCf\"\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&dateFrom=2023-06-01T02:45:44.087Z&dateTo=2023-06-30T23:59:59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "events" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "dateFrom", + "value": "2023-06-01T02:45:44.087Z" + }, + { + "key": "dateTo", + "value": "2023-06-30T23:59:59.999Z" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Unauthorized. The client is not recognized by authorization server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "text/plain" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&dateFrom=2023-06-01T02:45:44.087Z&dateTo=2023-06-30T23:59:59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "events" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "dateFrom", + "value": "2023-06-01T02:45:44.087Z" + }, + { + "key": "dateTo", + "value": "2023-06-30T23:59:59.999Z" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "Unauthorized" + }, + { + "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&dateFrom=2023-06-01T02:45:44.087Z&dateTo=2023-06-30T23:59:59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "events" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "dateFrom", + "value": "2023-06-01T02:45:44.087Z" + }, + { + "key": "dateTo", + "value": "2023-06-30T23:59:59.999Z" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/events?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&dateFrom=2023-06-01T02:45:44.087Z&dateTo=2023-06-30T23:59:59.999Z&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&managementUserIds=ea691ed4-90ff-4be2-bd85-f2c74efa72c3&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf&clientIds=54rp8Z8yGnlva19mThj7tJzNXFSyXrCf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "events" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "dateFrom", + "value": "2023-06-01T02:45:44.087Z" + }, + { + "key": "dateTo", + "value": "2023-06-30T23:59:59.999Z" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "managementUserIds", + "value": "ea691ed4-90ff-4be2-bd85-f2c74efa72c3" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + }, + { + "key": "clientIds", + "value": "54rp8Z8yGnlva19mThj7tJzNXFSyXrCf" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for retrieving platform analytics data." + }, + { + "name": "Messaging", + "item": [ + { + "name": "Sign a message", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"didUrl\": \"did:web:organization.com#2vcj3MjR4d\",\n \"payload\": {\n \"msg\": \"this is a message\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Accepts a message payload and signs it with a JWS (JSON Web Signature) using the a specific key from the DID (Decentralized Identifier) provided in the request.\n\n### **Analytic events**\n* MESSAGING_SIGN_START\n* MESSAGING_SIGN_SUCCESS\n* MESSAGING_SIGN_FAIL" + }, + "response": [ + { + "name": "Message signed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"didUrl\": \"did:web:organization.com#2vcj3MjR4d\",\n \"payload\": {\n \"msg\": \"this is a message\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "\"eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDprZXk6ejZNa21mazNtMldIQlVxVm94SlZ3R1NQejVrYmFKNnpBMXRwN1JRWUJiUUdtczNoI3o2TWttZmszbTJXSEJVcVZveEpWd0dTUHo1a2JhSjZ6QTF0cDdSUVlCYlFHbXMzaCJ9.eyJtc2ciOiJUaGlzIGlzIGEgcGF5bG9hZCJ9.5E9qEmmSOMHLABAr4A9VzuNKFaO4EDo2GSCMoxQm9zsE7eCmEEuaAxtNhOUdd-Wvj64vqBBVl84XB1Yg7X9wBg\"" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"didUrl\": \"did:web:organization.com#2vcj3MjR4d\",\n \"payload\": {\n \"msg\": \"this is a message\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Verify a message", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Verifies the signature of a provided JWS (JSON Web Signature), validating that the payload has not been tampered with and verifying that the kid in the JWS header is the same as the `iss` value in the Request Object.\n\nOne use case for verifying a JWS with a DID is when the Mobile Wallet App sends a Request Object to an OpenID Provider as part of the Authorization Code Flow (as per https://openid.net/specs/openid-connect-core-1_0-final.html#RequestObject). The Request Object is wrapped in a JWS with a signature that is generated from the Subject DID on the mobile app. Therefore verifying the JWS proves that the mobile app has access to the private key of the Subject DID.\n\n### **Analytic events**\n* MESSAGING_VERIFY_START\n* MESSAGING_VERIFY_SUCCESS\n* MESSAGING_VERIFY_FAIL" + }, + "response": [ + { + "name": "Verification successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"payload\": \"payload\",\n \"didUrl\": \"did:web:organization.com#2vcj3MjR4d\",\n \"did\": \"did:web:organization.com\",\n \"verified\": true,\n \"signerPublicJwk\": {\n \"kty\": \"OKP\",\n \"crv\": \"Ed25519\",\n \"x\": \"oQvDM6MvUdcgRCqKGJOgteRC9U06_x7bFtY0T-MJ1rQ\"\n }\n}" + }, + { + "name": "Invalid JWS", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Verification failed\"\n}" + } + ] + }, + { + "name": "Encrypt a message", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"senderDidUrl\": \"did:web:learn.vii.au01.mattr.global#z6LShWb1DVC2gkxoQ91VwHmNhci2A4NdVH4srFvLiTP6ETBK\",\n \"recipientDidUrls\": [\n \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\",\n \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN\"\n ],\n \"payload\": {\n \"id\": \"731961f2-bdc3-4f1e-8d59-cc308fd60ec8\",\n \"type\": \"https://mattr.global/schemas/verifiable-credential/offer/OidcCredentialProvider\",\n \"from\": \"did:web:learn.vii.au01.mattr.global\",\n \"created_time\": 1616466734,\n \"body\": {\n \"uri\": \"openid://discovery?issuer=https://tenant.vii.mattr.global/ext/oidc/v1/issuers/0dceeddd-f717-4bf2-b520-b3ddcd104a60\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/encrypt", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "encrypt" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Encrypts the provided payload using into a JWM (JSON Web Message) format.\n\n### **Analytic events**\n* MESSAGING_ENCRYPT_START\n* MESSAGING_ENCRYPT_SUCCESS\n* MESSAGING_ENCRYPT_FAIL\n" + }, + "response": [ + { + "name": "Message encrypted", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"senderDidUrl\": \"did:web:learn.vii.au01.mattr.global#z6LShWb1DVC2gkxoQ91VwHmNhci2A4NdVH4srFvLiTP6ETBK\",\n \"recipientDidUrls\": [\n \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\",\n \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN\"\n ],\n \"payload\": {\n \"id\": \"731961f2-bdc3-4f1e-8d59-cc308fd60ec8\",\n \"type\": \"https://mattr.global/schemas/verifiable-credential/offer/OidcCredentialProvider\",\n \"from\": \"did:web:learn.vii.au01.mattr.global\",\n \"created_time\": 1616466734,\n \"body\": {\n \"uri\": \"openid://discovery?issuer=https://tenant.vii.mattr.global/ext/oidc/v1/issuers/0dceeddd-f717-4bf2-b520-b3ddcd104a60\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/encrypt", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "encrypt" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"jwe\": {\n \"protected\": \"eyJhbGciOiJYQzIwUCJ9\",\n \"recipients\": [\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"JOLnYaD7L-Rszz7fczPhn6MkNre25PUsztzB1RHoz14\"\n },\n \"skid\": \"did:key:z6MkreuqFq6WrwozTeGKuUDz8bniTFRNAg8f3ZB862YdLp7v#z6LScyz3YLToyoKwZE6Tfq65hgZUkZdHrC4ZqohcUH9X6Twx\"\n },\n \"encryption_key\": \"ag5iKzjJOth9Wa68dCVKJW_vnO_Ga0zSJgQp5rIUg69HCzIjuNYhDg\"\n },\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"gDYW7rhG3cBqFp9trFETtlut6QJxYVVSoVWL7eN1bzE\"\n },\n \"skid\": \"did:key:z6MkreuqFq6WrwozTeGKuUDz8bniTFRNAg8f3ZB862YdLp7v#z6LScyz3YLToyoKwZE6Tfq65hgZUkZdHrC4ZqohcUH9X6Twx\"\n },\n \"encryption_key\": \"F5R5ZW7Yk7_iWT5kUWqv3w_tLI7V86tLRthjy_SSbGQ2pFyXKni_gA\"\n }\n ],\n \"ciphertext\": \"xpW-D6sDPpWc_jk87nEyxPX7JQV8_OZpaQft7ySQ5XmNhoj-lQyDkXDncOCyhB7yMSdZrRBNQjKxlEbpY_WLk1hBoWfsTeszVSAuFbX_VKUSJ7GR6rcnWGVNgDfKS8GsyC_owtswXatkF_65_mzFOygctkUmd2eI5bcpQpWjhw2vqnvnWkb7l2J27aWFF_c9cu52dB559j8lwLYyYC9oSMgV5piB6ppfrWBGo_DigjxvJcAYcjFYqFcT6A1nphPhwVTQ2HNfJodbQoseHub8UQdG4qAOcggq5DI84tbqor1SU9rdPH03jPkLgoO_aeXyJg5meITXoFSiu_tRfvf8QQ6vKq6pkTTXs8zKXcBCGhGIyKBNBG4R4RIY1UffTMnJQQQGBble3P06pGOnsnSop0BtygelB9M0ZEwnAUSAQqN1RR4AQwWcn9nH6hHEu1pMhSvhCuFNAPWS-hg24JGGw8Xe3EEZlLH0PM8qpUAfksPq\",\n \"iv\": \"FJq5zKvuPiUQIdRcMtiChHCJByuY8XK9\",\n \"tag\": \"u8kT0VAAtTswjGXxNpuX0g==\"\n }\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"senderDidUrl\": \"did:web:learn.vii.au01.mattr.global#z6LShWb1DVC2gkxoQ91VwHmNhci2A4NdVH4srFvLiTP6ETBK\",\n \"recipientDidUrls\": [\n \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\",\n \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN\"\n ],\n \"payload\": {\n \"id\": \"731961f2-bdc3-4f1e-8d59-cc308fd60ec8\",\n \"type\": \"https://mattr.global/schemas/verifiable-credential/offer/OidcCredentialProvider\",\n \"from\": \"did:web:learn.vii.au01.mattr.global\",\n \"created_time\": 1616466734,\n \"body\": {\n \"uri\": \"openid://discovery?issuer=https://tenant.vii.mattr.global/ext/oidc/v1/issuers/0dceeddd-f717-4bf2-b520-b3ddcd104a60\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/encrypt", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "encrypt" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"body\",\n \"msg\": \"Resource Not Found\",\n \"param\": \"senderDidUrl\",\n \"value\": \"did:key:z6MkopLiuMudqeRm1KvQ24jyUfn6pciePNomKqpsiMgeg4nT#z6LSmWEcPwNbxCgbuSMGTz1Gddnf9MsVSMJCfgPtksgThLvi\"\n }\n ]\n}" + } + ] + }, + { + "name": "Decrypt a message", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"jwe\": \"eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/decrypt", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "decrypt" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Decrypts a provided message where the tenant manages the keys for the defined `recipientDidUrl`.\n\n### **Analytic events**\n* MESSAGING_DECRYPT_START\n* MESSAGING_DECRYPT_SUCCESS\n* MESSAGING_DECRYPT_FAIL" + }, + "response": [ + { + "name": "Message Decrypted", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"jwe\": \"eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/decrypt", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "decrypt" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"payload\": \"string\",\n \"senderDidUrl\": \"did:web:organization.com#2vcj3MjR4d\",\n \"senderPublicJwk\": {},\n \"recipientDidUrl\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"jwe\": \"eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/decrypt", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "decrypt" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Send a message", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"to\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\",\n \"message\": {\n \"protected\": \"eyJhbGciOiJYQzIwUCJ9\",\n \"recipients\": [\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"kYsO02jWHATTJel6OpePqlkdDmKlE5VOr18UblgL8W0\"\n },\n \"skid\": \"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy\"\n },\n \"encryption_key\": \"n1VUf5SQdSFNtb8DHzYfJJ_lFhJcGDAPJWG8Y1W3d2qYyPzyxMhyaA\"\n },\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"P3jcIMPGK8thxyHxUsWB5fEsLnltJqRDWMNywtexk24\"\n },\n \"skid\": \"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy\"\n },\n \"encryption_key\": \"5ZOTqwj8NredkXEOp4ZDLL1ohRQqNTS508BTkLlUVCkDoYvizCIdrg\"\n }\n ],\n \"ciphertext\": \"Dl4zBqMeEDwcnyyc17nYvSQ048fcsha_Lm0dfer1nqfo5y8oHvD2VGNTp_lawNJMWCzQF3NDZxxKFz__wTUeHCqisCE_DWbjo_W-R3avzW9S-JFajv9NRtjlfd5yp-1TtD2N5d-8oTtMGdAxq3dftN2Od1xRe4stubJBebl3nf8-lG99DIVGdL8Y-D98kFDxnMxgCKn4RXyHnMowFWlhQCooLeYqo8aWjqVFkzuJzn-p47W7rV9BCuoVThhVuNkjQm_dhBrqu0QMpjJucz7OvOHp0mojdYNKwvWT6dfOVNXetMlKjWCGtCTNFaDTGLc4agdcTjAlaF1iedcVXDOLqVvEugXWGlusE3a68y6gmPnqHjXR6CsEfPwkb5hKKtsyrh1eHu_9UUang5o6N76mummVw4UZkDF6tP1PVGPvyctz82tthnOcjO5mZQG41xfMEMNxWtF8P8wCh4LotpdexXtYigzBgkI1Qoa_FK1czYWAUovysAJCTOZtmg==\",\n \"iv\": \"jSd3E-ElCHE-QhSDxrQ-Jv4eQhkxOj0s\",\n \"tag\": \"dbDolGVDdvYsYdn-vVrICw==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/send", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "send" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Sends an encrypted JWM (JSON Web Messaging) format message to a service endpoint defined in a public DID document.\n\n### **Analytic events**\n* MESSAGING_SEND_START\n* MESSAGING_SEND_SUCCESS\n* MESSAGING_SEND_FAIL" + }, + "response": [ + { + "name": "Message sent", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"to\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\",\n \"message\": {\n \"protected\": \"eyJhbGciOiJYQzIwUCJ9\",\n \"recipients\": [\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"kYsO02jWHATTJel6OpePqlkdDmKlE5VOr18UblgL8W0\"\n },\n \"skid\": \"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy\"\n },\n \"encryption_key\": \"n1VUf5SQdSFNtb8DHzYfJJ_lFhJcGDAPJWG8Y1W3d2qYyPzyxMhyaA\"\n },\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"P3jcIMPGK8thxyHxUsWB5fEsLnltJqRDWMNywtexk24\"\n },\n \"skid\": \"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy\"\n },\n \"encryption_key\": \"5ZOTqwj8NredkXEOp4ZDLL1ohRQqNTS508BTkLlUVCkDoYvizCIdrg\"\n }\n ],\n \"ciphertext\": \"Dl4zBqMeEDwcnyyc17nYvSQ048fcsha_Lm0dfer1nqfo5y8oHvD2VGNTp_lawNJMWCzQF3NDZxxKFz__wTUeHCqisCE_DWbjo_W-R3avzW9S-JFajv9NRtjlfd5yp-1TtD2N5d-8oTtMGdAxq3dftN2Od1xRe4stubJBebl3nf8-lG99DIVGdL8Y-D98kFDxnMxgCKn4RXyHnMowFWlhQCooLeYqo8aWjqVFkzuJzn-p47W7rV9BCuoVThhVuNkjQm_dhBrqu0QMpjJucz7OvOHp0mojdYNKwvWT6dfOVNXetMlKjWCGtCTNFaDTGLc4agdcTjAlaF1iedcVXDOLqVvEugXWGlusE3a68y6gmPnqHjXR6CsEfPwkb5hKKtsyrh1eHu_9UUang5o6N76mummVw4UZkDF6tP1PVGPvyctz82tthnOcjO5mZQG41xfMEMNxWtF8P8wCh4LotpdexXtYigzBgkI1Qoa_FK1czYWAUovysAJCTOZtmg==\",\n \"iv\": \"jSd3E-ElCHE-QhSDxrQ-Jv4eQhkxOj0s\",\n \"tag\": \"dbDolGVDdvYsYdn-vVrICw==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/send", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "send" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"to\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d\",\n \"message\": {\n \"protected\": \"eyJhbGciOiJYQzIwUCJ9\",\n \"recipients\": [\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"kYsO02jWHATTJel6OpePqlkdDmKlE5VOr18UblgL8W0\"\n },\n \"skid\": \"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy\"\n },\n \"encryption_key\": \"n1VUf5SQdSFNtb8DHzYfJJ_lFhJcGDAPJWG8Y1W3d2qYyPzyxMhyaA\"\n },\n {\n \"header\": {\n \"alg\": \"ECDH-1PU+A256KW\",\n \"kid\": \"did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd\",\n \"epk\": {\n \"kty\": \"OKP\",\n \"crv\": \"X25519\",\n \"x\": \"P3jcIMPGK8thxyHxUsWB5fEsLnltJqRDWMNywtexk24\"\n },\n \"skid\": \"did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy\"\n },\n \"encryption_key\": \"5ZOTqwj8NredkXEOp4ZDLL1ohRQqNTS508BTkLlUVCkDoYvizCIdrg\"\n }\n ],\n \"ciphertext\": \"Dl4zBqMeEDwcnyyc17nYvSQ048fcsha_Lm0dfer1nqfo5y8oHvD2VGNTp_lawNJMWCzQF3NDZxxKFz__wTUeHCqisCE_DWbjo_W-R3avzW9S-JFajv9NRtjlfd5yp-1TtD2N5d-8oTtMGdAxq3dftN2Od1xRe4stubJBebl3nf8-lG99DIVGdL8Y-D98kFDxnMxgCKn4RXyHnMowFWlhQCooLeYqo8aWjqVFkzuJzn-p47W7rV9BCuoVThhVuNkjQm_dhBrqu0QMpjJucz7OvOHp0mojdYNKwvWT6dfOVNXetMlKjWCGtCTNFaDTGLc4agdcTjAlaF1iedcVXDOLqVvEugXWGlusE3a68y6gmPnqHjXR6CsEfPwkb5hKKtsyrh1eHu_9UUang5o6N76mummVw4UZkDF6tP1PVGPvyctz82tthnOcjO5mZQG41xfMEMNxWtF8P8wCh4LotpdexXtYigzBgkI1Qoa_FK1czYWAUovysAJCTOZtmg==\",\n \"iv\": \"jSd3E-ElCHE-QhSDxrQ-Jv4eQhkxOj0s\",\n \"tag\": \"dbDolGVDdvYsYdn-vVrICw==\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/send", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "send" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for signing, encrypting, decrypting and sending messages." + }, + { + "name": "Inboxes", + "item": [ + { + "name": "Create an inbox", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My_Inbox\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates an inbox that can register DIDs and then hold messages sent to those DIDs service points.\n\n### **Analytic events**\n* MESSAGING_INBOX_CREATE_START\n* MESSAGING_INBOX_CREATE_SUCCESS\n* MESSAGING_INBOX_CREATE_FAIL" + }, + "response": [ + { + "name": "Inbox created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My_Inbox\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"f04faabf-cea8-4f39-95b3-0ce357ac4d03\",\n \"name\": \"My_Inbox\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My_Inbox\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "List inboxes", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all inboxes on the tenant.\n\n### **Analytic events**\n* MESSAGING_INBOX_RETRIEVE_LIST_START\n* MESSAGING_INBOX_RETRIEVE_LIST_SUCCESS\n* MESSAGING_INBOX_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "A list of inboxes", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"f04faabf-cea8-4f39-95b3-0ce357ac4d03\",\n \"name\": \"My_Inbox\"\n },\n {\n \"id\": \"f04faabf-cea8-4f39-95b3-0ce357ac4d03\",\n \"name\": \"My_Inbox\"\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + } + ] + }, + { + "name": "Retrieve an inbox", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an inbox based on its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_RETRIEVE_START\n* MESSAGING_INBOX_RETRIEVE_SUCCESS\n* MESSAGING_INBOX_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Inbox returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"f04faabf-cea8-4f39-95b3-0ce357ac4d03\",\n \"name\": \"My_Inbox\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an inbox", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Update the inbox configurations" + }, + "response": [ + { + "name": "Inbox updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"f04faabf-cea8-4f39-95b3-0ce357ac4d03\",\n \"name\": \"My_Inbox\"\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an inbox", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an inbox by providing its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_DELETE_START\n* MESSAGING_INBOX_DELETE_SUCCESS\n* MESSAGING_INBOX_DELETE_FAIL" + }, + "response": [ + { + "name": "Inbox deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Register DID with an inbox", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"did\": \"string\",\n \"jwt\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Register the provided DID to the requested inbox.\n\n> DID registration with inboxes is currently limited to `did:key`'\n\n### **Analytic events**\n* MESSAGING_INBOX_DID_REGISTER_START\n* MESSAGING_INBOX_DID_REGISTER_SUCCESS\n* MESSAGING_INBOX_DID_REGISTER_FAIL" + }, + "response": [ + { + "name": "DID registered with inbox", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"did\": \"string\",\n \"jwt\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"did\": \"string\"\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"did\": \"string\",\n \"jwt\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"did\": \"string\",\n \"jwt\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve inbox DIDs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all the DIDs registered with the requested inbox.\n\n### **Analytic events**\n* MESSAGING_INBOX_DID_RETRIEVE_LIST_START\n* MESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESS\n* MESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "A list of inbox DIDs", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n \"did:key:did1\",\n \"did:key:did2\",\n \"did:key:did3\"\n ]\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Unregister DID with an inbox", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids/:did", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids", + ":did" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "did", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Unregisters a DID from the requested inbox.\n\n### **Analytic events**\n* MESSAGING_INBOX_DID_UNREGISTER_START\n* MESSAGING_INBOX_DID_UNREGISTER_SUCCESS\n* MESSAGING_INBOX_DID_UNREGISTER_FAIL" + }, + "response": [ + { + "name": "DID unregistered from inbox", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids/:did", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids", + ":did" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "did", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids/:did", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids", + ":did" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "did", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/dids/:did", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "dids", + ":did" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "did", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all messages", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieving all the messages from an inbox\n\n### **Analytic events**\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_START\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_SUCCESS\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "A list of inbox messages", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"name\": \"string\",\n \"createdAt\": \"2011-10-18\",\n \"id\": \"string\",\n \"inboxId\": \"string\",\n \"payload\": \"string\"\n },\n {\n \"name\": \"string\",\n \"createdAt\": \"1965-07-29\",\n \"id\": \"string\",\n \"inboxId\": \"string\",\n \"payload\": \"string\"\n }\n ]\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a message", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a message from the requested inbox by providing its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_START\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_SUCCESS\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "An inbox message", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"string\",\n \"createdAt\": \"1992-05-20\",\n \"id\": \"string\",\n \"inboxId\": \"string\",\n \"payload\": \"string\"\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a message", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a message from the requested inbox by providing its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_MESSAGE_DELETE_START\n* MESSAGING_INBOX_MESSAGE_DELETE_SUCCESS\n* MESSAGING_INBOX_MESSAGE_DELETE_FAIL\n" + }, + "response": [ + { + "name": "Message deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"notUUIDvalue\",\n \"msg\": \"Invalid value\",\n \"param\": \"inboxId\",\n \"location\": \"params\"\n }\n ]\n}" + }, + { + "name": "Not Found", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/messaging/inboxes/:id/messages/:messageid", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "messaging", + "inboxes", + ":id", + "messages", + ":messageid" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Requested inbox ID" + }, + { + "key": "messageid", + "value": "string", + "description": "(Required) Requested message ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Resource Not Found\"\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing inboxes." + } + ] + }, + { + "name": "Tenant configuration", + "item": [ + { + "name": "Security", + "item": [ + { + "name": "Create API Auth Token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"htf792W4p4MedZbnoWAs51EfqUt4d2\",\n \"client_secret\": \"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G\",\n \"audience\": \"https://learn.vii.au01.mattr.global\",\n \"grant_type\": \"client_credentials\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{oauth-token-Url}}/oauth/token", + "host": [ + "{{oauth-token-Url}}" + ], + "path": [ + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Authorization endpoint for gaining token used for API requests requiring `bearerAuth`.\n\nYou will be provided the required `client_id` and `client_secret` as part of onboarding.\n\n> The returned bearer token will only enable access to endpoints as per your client's defined role. Refer to [Access Control](https://learn.mattr.global/docs/platform-management/access-control) for more information." + }, + "response": [ + { + "name": "Successful response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"htf792W4p4MedZbnoWAs51EfqUt4d2\",\n \"client_secret\": \"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G\",\n \"audience\": \"https://learn.vii.au01.mattr.global\",\n \"grant_type\": \"client_credentials\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{oauth-token-Url}}/oauth/token", + "host": [ + "{{oauth-token-Url}}" + ], + "path": [ + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"access_token\": \"s2dgbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6s2dcaEROemRDf5gbRVEwTTVSVFE0TmtZME9UZzVNVEpDTlVJNFJqRTBPREExTmpZMk1qazFPQSJ9\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\"\n}" + }, + { + "name": "Unauthorized", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"client_id\": \"htf792W4p4MedZbnoWAs51EfqUt4d2\",\n \"client_secret\": \"d3fYDX7FjPg1D1h2viARXsolPByQ9vMfg8LHylBy8F4s5KJLB4HhHGOxxqJnSj3G\",\n \"audience\": \"https://learn.vii.au01.mattr.global\",\n \"grant_type\": \"client_credentials\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{oauth-token-Url}}/oauth/token", + "host": [ + "{{oauth-token-Url}}" + ], + "path": [ + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"error\": \"access_denied\",\n \"error_description\": \"Unauthorized\"\n}" + } + ] + } + ], + "description": "Specifies paths and operations for accessing protected endpoints." + }, + { + "name": "Custom Domain", + "item": [ + { + "name": "Configure custom domain", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a custom domain configuration on your tenant. You can configure a custom domain for a specific MATTR VII tenant to represent your brand and instil trust with your end-users. Any MATTR VII tenant can only have one custom domain. Refer to our [docs](https://learn.mattr.global/docs/capabilities/platform-management/custom) for more information.\n\n> Custom domains are only available as part of our paid plans, and trial accounts do not include ongoing access to custom domains. The APIs are available for you to trial the feature, but they may be deactivated unless you switch to a paid plan.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_CREATE_START\n* CONFIG_CUSTOM_DOMAIN_CREATE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Custom domain created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\",\n \"verificationToken\": \"8c6f36c1-91ff-439d-a518-48cf7ef421ef\",\n \"isVerified\": false\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve custom domain", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns your tenant's custom domain configuration and its verification status.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_RETRIEVE_START\n* CONFIG_CUSTOM_DOMAIN_RETRIEVE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Custom domain returned", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.icon\",\n \"domain\": \"example.com\",\n \"verificationToken\": \"8c6f36c1-91ff-439d-a518-48cf7ef421ef\",\n \"isVerified\": true,\n \"verifiedAt\": \"2024-01-31T20:31:48.340Z\"\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete custom domain", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes the custom domain configuration on your tenant.\n\n> Deleting your custom domain configuration breaks the linkage with any credentials issued under the custom domain. These credentials will no longer be valid.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_DELETE_START\n* CONFIG_CUSTOM_DOMAIN_DELETE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_DELETE_FAIL" + }, + "response": [ + { + "name": "Custom domain deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update custom domain", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates the custom domain configuration.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_UPDATE_START\n* CONFIG_CUSTOM_DOMAIN_UPDATE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_UPDATE_FAIL" + }, + "response": [ + { + "name": "Custom Domain updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.icon\",\n \"domain\": \"example.com\",\n \"verificationToken\": \"8c6f36c1-91ff-439d-a518-48cf7ef421ef\",\n \"isVerified\": true,\n \"verifiedAt\": \"2021-04-15T07:37:25.008Z\"\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example Corp\",\n \"logoUrl\": \"https://cdn.example.com/logo.jpg\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/config/domain", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Verify custom domain", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Verifies that you have control of the configured custom domain by examining its TXT record.\n\n> Your custom domain will not be active until you verify it. Refer to [Verify domain ownership](https://learn.mattr.global/docs/capabilities/platform-management/custom#verify-domain-ownership) for more information.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_VERIFY_START\n* CONFIG_CUSTOM_DOMAIN_VERIFY_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_VERIFY_FAIL" + }, + "response": [ + { + "name": "Custom domain verified", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/config/domain/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "config", + "domain", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing custom domains." + }, + { + "name": "Webhooks", + "item": [ + { + "name": "Create Webhook", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new webhook for this tenant.\n\n### **Analytic events**\n* WEBHOOK_CREATE_START\n* WEBHOOK_CREATE_SUCCESS\n* WEBHOOK_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Webhook created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": false\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Webhooks", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of webhooks configured on the tenant.\n\n### **Analytic events**\n* WEBHOOK_RETRIEVE_LIST_START\n* WEBHOOK_RETRIEVE_LIST_SUCCESS\n* WEBHOOK_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Webhooks retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": false\n },\n {\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": false\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjItMDgtMjJUMDElM0E1OSUzQTE5LjYyMFomaWQ9MGMwOTk2MTEtMTljNC00ZjI5LTg3MjQtNmI5ZTViYTFlZjdj\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve Webhook", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) The requested Webhook ID." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve a specific Webhook by providing its ID.\n\n### **Analytic events**\n* WEBHOOK_RETRIEVE_START\n* WEBHOOK_RETRIEVE_SUCCESS\n* WEBHOOK_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Webhook retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) The requested Webhook ID." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": false\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) The requested Webhook ID." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update Webhook", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing Webhook by providing its ID.\n\n### **Analytic events**\n* WEBHOOK_UPDATE_START\n* WEBHOOK_UPDATE_SUCCESS\n* WEBHOOK_UPDATE_FAIL" + }, + "response": [ + { + "name": "Webhook updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0c099611-19c4-4f29-8724-6b9e5ba1ef7c\",\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": false\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"events\": [\n \"OpenIdCredentialIssued\"\n ],\n \"url\": \"https://example.com\",\n \"disabled\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete Webhook", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a Webhook by providing its ID.\n\n### **Analytic events**\n* WEBHOOK_DELETE_START\n* WEBHOOK_DELETE_SUCCESS\n* WEBHOOK_DELETE_FAIL\n" + }, + "response": [ + { + "name": "Webhook deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Webhook ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve Webhook JWKs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/jwks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + "jwks" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of Webhook JWKs (JSON Web Keys) from the tenant. These keys can be used to verify the HTTP signature and validate the integrity and authorship of generated Webhooks. This endpoint does not require authentication and is publicly available by design.\n" + }, + "response": [ + { + "name": "Webhook JWKs retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/webhooks/jwks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "webhooks", + "jwks" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"keys\": [\n {\n \"kty\": \"OKP\",\n \"crv\": \"Ed25519\",\n \"x\": \"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo\",\n \"use\": \"sig\",\n \"kid\": \"FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ\"\n },\n {\n \"kty\": \"OKP\",\n \"crv\": \"Ed25519\",\n \"x\": \"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo\",\n \"use\": \"sig\",\n \"kid\": \"FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Webhooks." + }, + { + "name": "Identifiers", + "item": [ + { + "name": "DIDs", + "item": [ + { + "name": "Well known DID configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/.well-known/did-configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ".well-known", + "did-configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of Decentralized Identifier (DID) Configuration entries from the tenant. These are automatically created for **all** DIDS created on a tenant so that they can be used by any party aiming to establish and verify the domain-DID linkage by exposing cryptographic proofs. Thus, this endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party. Refer to [Well Known DID Configuration](https://identity.foundation/.well-known/resources/did-configuration) on the Decentralized Identity Foundation website for more information.\n" + }, + "response": [ + { + "name": "List of DID Configuration entries", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/.well-known/did-configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ".well-known", + "did-configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"entries\": [\n {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://identity.foundation/.well-known/contexts/did-configuration-v0.2.jsonld\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"DomainLinkageCredential\"\n ],\n \"issuer\": \"did:key:z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df\",\n \"issuanceDate\": \"2023-07-19T00:46:39.327Z\",\n \"credentialSubject\": {\n \"id\": \"did:key:z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df\",\n \"origin\": \"tenant.vii.mattr.global\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2023-07-19T00:46:39Z\",\n \"verificationMethod\": \"did:key:z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df#z6MktarAWYW9iUWN2f9oAdHhFXdD9ZKRoEiQyPhQffBho4Df\",\n \"proofPurpose\": \"assertionMethod\",\n \"jws\": \"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..jx6VQ_iB80R2GVcqy-hBGHp0A-u-i9ynye7ipb0p4z-4I2ww8tgcut3JadipHUgTS9Qs2YwY2abUsj3045ywDA\"\n }\n },\n {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://identity.foundation/.well-known/contexts/did-configuration-v0.2.jsonld\",\n \"https://w3id.org/security/bbs/v2\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"DomainLinkageCredential\"\n ],\n \"issuer\": \"did:key:zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K\",\n \"issuanceDate\": \"2023-07-19T00:46:39.328Z\",\n \"credentialSubject\": {\n \"id\": \"did:key:zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K\",\n \"origin\": \"product-team.platform.staging.mattrlabs.io\"\n },\n \"proof\": {\n \"type\": \"BbsSignature2022\",\n \"verificationMethod\": \"did:key:zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K#zUC745TL4zAa8D8qqHnwcmLj7QFcTbgsh41x6sbkRARPokFFvykvk6jjotsEmjpXniEQsm9r5LkSfXKXXu9F5698uDoQ9Bq8MeLtisqUoJJ1SZRa9tsU5EFfD2T2dR58RFMPW9K\",\n \"proofPurpose\": \"assertionMethod\",\n \"proofValue\": \"x8AFZpr/CUbwC4qony2g8BpW7hdF+KhM363b0jQ6MI+FFsKzwug92JDdeSXaFaZyCvfhkJrIdDGMAzyLSp9kJqH4B2cqPw2AcEsoNrTqxOEw9ZK7D1LXAkvElUhfmIZLKAmGpA8RNVPUG8Q+a2p49w==\"\n }\n }\n ]\n}" + } + ] + }, + { + "name": "Create a DID", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"method\": \"web\",\n \"options\": {\n \"url\": \"learn.vii.au01.mattr.global\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Takes a supported [DID method](https://learn.mattr.global/docs/formats/json/dids#methods) and returns a new DID with its generated keys and required information. This endpoint also registers the DID Document when applicable.\n\nMATTR VII currently supports creating DIDs of the following methods:\n- **did:key**: The most basic type of DID. The public key forms the DID and has no further data associated with it.\n- **did:web**: This type of DID requires hosting the DID document on a publicly accessible domain in order to make the document and its contents available.\n\n### **Analytic events**\n* DID_CREATE_START\n* DID_CREATE_SUCCESS\n* DID_CREATE_FAIL" + }, + "response": [ + { + "name": "DID document created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"method\": \"web\",\n \"options\": {\n \"url\": \"learn.vii.au01.mattr.global\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"did\": \"did:web:learn.vii.au01.mattr.global\",\n \"registrationStatus\": \"COMPLETED\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"kmsKeyId\": \"96fa6a94-a8cf-4afd-825b-70b46bdb60ee\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\",\n \"kmsKeyId\": \"378dfe87-6eba-4779-a402-34ff5b267840\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"kmsKeyId\": \"a0cba537-ffe1-486d-aedd-6ead80e75519\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t\",\n \"kmsKeyId\": \"250c4e1f-bae3-44ca-9f4e-4f7ff15851e2\"\n }\n ],\n \"registered\": 1674421454614,\n \"initialDidDocument\": {\n \"@context\": [\n \"https://w3.org/ns/did/v1\",\n \"https://w3id.org/security/suites/x25519-2019/v1\",\n \"https://w3id.org/security/suites/jws-2020/v1\",\n \"https://w3id.org/security/suites/ed25519-2018/v1\",\n \"https://w3id.org/security/bbs/v1\"\n ],\n \"id\": \"did:web:learn.vii.au01.mattr.global\",\n \"verificationMethod\": [\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"JsonWebKey2020\",\n \"publicKeyJwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-256\",\n \"x\": \"PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w\",\n \"y\": \"7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI\"\n }\n },\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"Ed25519VerificationKey2018\",\n \"publicKeyBase58\": \"2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24\"\n },\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"Bls12381G2Key2020\",\n \"publicKeyBase58\": \"nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB\"\n }\n ],\n \"authentication\": [\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\"\n ],\n \"assertionMethod\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"capabilityDelegation\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"capabilityInvocation\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"keyAgreement\": [\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"X25519KeyAgreementKey2019\",\n \"publicKeyBase58\": \"CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7\"\n }\n ]\n }\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"method\": \"web\",\n \"options\": {\n \"url\": \"learn.vii.au01.mattr.global\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/dids", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a list of DIDs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all DIDs (Decentralized Identifiers) managed by the tenant and their associated meta-data.\n\n### **Analytic events**\n* DID_RETRIEVE_LIST_START\n* DID_RETRIEVE_LIST_SUCCESS\n* DID_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "A list of DIDs", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"did\": \"did:web:learn.vii.au01.mattr.global\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"kmsKeyId\": \"96fa6a94-a8cf-4afd-825b-70b46bdb60ee\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\",\n \"kmsKeyId\": \"378dfe87-6eba-4779-a402-34ff5b267840\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"kmsKeyId\": \"a0cba537-ffe1-486d-aedd-6ead80e75519\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t\",\n \"kmsKeyId\": \"250c4e1f-bae3-44ca-9f4e-4f7ff15851e2\"\n }\n ],\n \"registered\": 1674421454614,\n \"initialDidDocument\": {\n \"@context\": [\n \"https://w3.org/ns/did/v1\",\n \"https://w3id.org/security/suites/x25519-2019/v1\",\n \"https://w3id.org/security/suites/jws-2020/v1\",\n \"https://w3id.org/security/suites/ed25519-2018/v1\",\n \"https://w3id.org/security/bbs/v1\"\n ],\n \"id\": \"did:web:learn.vii.au01.mattr.global\",\n \"verificationMethod\": [\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"JsonWebKey2020\",\n \"publicKeyJwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-256\",\n \"x\": \"PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w\",\n \"y\": \"7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI\"\n }\n },\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"Ed25519VerificationKey2018\",\n \"publicKeyBase58\": \"2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24\"\n },\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"Bls12381G2Key2020\",\n \"publicKeyBase58\": \"nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB\"\n }\n ],\n \"authentication\": [\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\"\n ],\n \"assertionMethod\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"capabilityDelegation\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"capabilityInvocation\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"keyAgreement\": [\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"X25519KeyAgreementKey2019\",\n \"publicKeyBase58\": \"CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7\"\n }\n ]\n }\n }\n },\n {\n \"did\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"kmsKeyId\": \"2462a440-ef70-413b-8e73-0b2905a73562\",\n \"didDocumentKeyId\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\"\n },\n {\n \"kmsKeyId\": \"e65e6545-1ba0-4959-8272-db22a46f2e34\",\n \"didDocumentKeyId\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6LSsfqtdz5mtaGRTZrGwhzK73xDYAtack5AHKcakR1eco7K\"\n }\n ],\n \"registered\": 1671586060525,\n \"initialDidDocument\": {\n \"id\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\",\n \"@context\": [\n \"https://w3.org/ns/did/v1\",\n \"https://w3id.org/security/suites/x25519-2019/v1\",\n \"https://w3id.org/security/suites/ed25519-2018/v1\"\n ],\n \"verificationMethod\": [\n {\n \"id\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\",\n \"type\": \"Ed25519VerificationKey2018\",\n \"controller\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\",\n \"publicKeyBase58\": \"Bqf3SpwXEypMQq9txNrURNy1kZXzAPXKVwinChGztncB\"\n }\n ],\n \"keyAgreement\": [\n {\n \"id\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6LSsfqtdz5mtaGRTZrGwhzK73xDYAtack5AHKcakR1eco7K\",\n \"type\": \"X25519KeyAgreementKey2019\",\n \"controller\": \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\",\n \"publicKeyBase58\": \"Gzfj7gGuo7YgNBUWR4UMnTjjh2MTv8u1QLtuFxN7uRLZ\"\n }\n ],\n \"authentication\": [\n \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\"\n ],\n \"assertionMethod\": [\n \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\"\n ],\n \"capabilityDelegation\": [\n \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\"\n ],\n \"capabilityInvocation\": [\n \"did:key:z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ#z6MkqHv635BxaXJpXKzbdwpKGUX1a8oqaGmgBxdi2yF1p1PZ\"\n ]\n }\n }\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + } + ] + }, + { + "name": "Resolve a DID", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a DID and its metadata from the tenant by its URI. This may involve a network call depending on the method involved:\n- For did:key the public key is encapsulated in the DID URI itself.\n- For did:web it must be resolved by accessing the `/.well-known/did.json` path on its domain.\n\n### **Analytic events**\n* DID_RETRIEVE_START\n* DID_RETRIEVE_SUCCESS\n* DID_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "A DID Document and its meta-data", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"did\": \"did:web:learn.vii.au01.mattr.global\",\n \"registrationStatus\": \"COMPLETED\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"kmsKeyId\": \"96fa6a94-a8cf-4afd-825b-70b46bdb60ee\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\",\n \"kmsKeyId\": \"378dfe87-6eba-4779-a402-34ff5b267840\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"kmsKeyId\": \"a0cba537-ffe1-486d-aedd-6ead80e75519\"\n },\n {\n \"didDocumentKeyId\": \"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t\",\n \"kmsKeyId\": \"250c4e1f-bae3-44ca-9f4e-4f7ff15851e2\"\n }\n ],\n \"registered\": 1674421454614,\n \"initialDidDocument\": {\n \"@context\": [\n \"https://w3.org/ns/did/v1\",\n \"https://w3id.org/security/suites/x25519-2019/v1\",\n \"https://w3id.org/security/suites/jws-2020/v1\",\n \"https://w3id.org/security/suites/ed25519-2018/v1\",\n \"https://w3id.org/security/bbs/v1\"\n ],\n \"id\": \"did:web:learn.vii.au01.mattr.global\",\n \"verificationMethod\": [\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"JsonWebKey2020\",\n \"publicKeyJwk\": {\n \"kty\": \"EC\",\n \"crv\": \"P-256\",\n \"x\": \"PZWoBmV7vjJ55Aq5hFAPIH6uDA-V3G0ueVe22ahgL7w\",\n \"y\": \"7kzcj257Zvfpzyj2gFWrnCIbXZxQ6WyDOo2MdA6mpMI\"\n }\n },\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"Ed25519VerificationKey2018\",\n \"publicKeyBase58\": \"2vcj3MjR4dSKq5asFQ9oor7iZsqTKTfBpjLHgaP15Y24\"\n },\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"Bls12381G2Key2020\",\n \"publicKeyBase58\": \"nCxqyzxHFioYCVwinAwJzTPwfs84pPaseZQFkfGXUxx5ZD93HE43aXicYsyj2s5HYFSSYw9WtRaWsKeF9qn2jBVZ2UNuQCdG1qna9jpZPTvWQY1t2Z2hxhhs8MV5P5QaozB\"\n }\n ],\n \"authentication\": [\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\"\n ],\n \"assertionMethod\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"capabilityDelegation\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"capabilityInvocation\": [\n \"did:web:learn.vii.au01.mattr.global#z12KiP7r\",\n \"did:web:learn.vii.au01.mattr.global#2vcj3MjR4d\",\n \"did:web:learn.vii.au01.mattr.global#nCxqyzxHFi\"\n ],\n \"keyAgreement\": [\n {\n \"id\": \"did:web:learn.vii.au01.mattr.global#CU6dJt9p8t\",\n \"controller\": \"did:web:learn.vii.au01.mattr.global\",\n \"type\": \"X25519KeyAgreementKey2019\",\n \"publicKeyBase58\": \"CU6dJt9p8twE4hmyGVFbVpUMmu6G732bVgD1tNupwYY7\"\n }\n ]\n }\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a DID", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a DID and all associated metadata by providing its URI. This includes all the removal of all associated private keys from the Key Management System (KMS).\n> For `did:web` you will need to manually remove the `did.json` from your hosted domain.\n\n### **Analytic events**\n* DID_DELETE_START\n* DID_DELETE_SUCCESS\n* DID_DELETE_FAIL" + }, + "response": [ + { + "name": "DID successfully deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/dids/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "dids", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9", + "description": "(Required) DID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing DIDs." + }, + { + "name": "IACA", + "item": [ + { + "name": "Create an IACA", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"country\": \"US\",\n \"notBefore\": \"2024-09-26\",\n \"notAfter\": \"2034-09-26\",\n \"stateOrProvinceName\": \"US-AL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new IACA that can be used to sign certificates for Document and Status List signers.\n- IACAs are always created as inactive. You must manually [update](#operation/update-mobile-credential-iaca) the IACA to [`active: true`](#operation/update-mobile-credential-iaca!path=active&t=request) before it can be used to sign mDocs.\n- A maximum of three IACAs can be created per tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_CREATE_START\n* MOBILE_CREDENTIAL_IACA_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_IACA_CREATE_FAIL" + }, + "response": [ + { + "name": "IACA created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"country\": \"US\",\n \"notBefore\": \"2024-09-26\",\n \"notAfter\": \"2034-09-26\",\n \"stateOrProvinceName\": \"US-AL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"bac509a4-6c63-9425-f743-b33d230f9b46\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\\r\\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\\r\\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\\r\\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\\r\\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\\r\\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\\r\\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\\r\\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\\r\\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\\r\\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\\r\\nvkM=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"certificateData\": {\n \"notAfter\": \"2034-09-26\",\n \"notBefore\": \"2023-09-26\",\n \"country\": \"US\",\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"stateOrProvinceName\": \"US-AL\"\n },\n \"certificateFingerprint\": \"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311\",\n \"isManaged\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"country\": \"US\",\n \"notBefore\": \"2024-09-26\",\n \"notAfter\": \"2034-09-26\",\n \"stateOrProvinceName\": \"US-AL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Maximum number of IACA certificates reached. Please delete an existing certificate before creating a new one.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"country\": \"US\",\n \"notBefore\": \"2024-09-26\",\n \"notAfter\": \"2034-09-26\",\n \"stateOrProvinceName\": \"US-AL\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all IACAs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all existing IACAs from the tenant.\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "IACAs Retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"31b89728-9fbc-9949-9f3d-6bda59a34ea2\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\\r\\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\\r\\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\\r\\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\\r\\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\\r\\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\\r\\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\\r\\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\\r\\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\\r\\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\\r\\nvkM=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"certificateData\": {\n \"notAfter\": \"2034-09-26\",\n \"notBefore\": \"2023-09-26\",\n \"country\": \"US\",\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"stateOrProvinceName\": \"US-AL\"\n },\n \"certificateFingerprint\": \"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311\",\n \"isManaged\": true\n },\n {\n \"id\": \"f58fe8cb-3de5-bf18-3aa9-846bc2d1f2ca\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\\r\\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\\r\\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\\r\\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\\r\\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\\r\\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\\r\\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\\r\\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\\r\\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\\r\\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\\r\\nvkM=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"certificateData\": {\n \"notAfter\": \"2034-09-26\",\n \"notBefore\": \"2023-09-26\",\n \"country\": \"US\",\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"stateOrProvinceName\": \"US-AL\"\n },\n \"certificateFingerprint\": \"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311\",\n \"isManaged\": true\n }\n ],\n \"nextCursor\": \"string\"\n}" + } + ] + }, + { + "name": "Retrieve an IACA", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing IACA by providing its ID.\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_START\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "IACA retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"bac509a4-6c63-9425-f743-b33d230f9b46\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\\r\\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\\r\\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\\r\\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\\r\\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\\r\\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\\r\\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\\r\\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\\r\\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\\r\\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\\r\\nvkM=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"certificateData\": {\n \"notAfter\": \"2034-09-26\",\n \"notBefore\": \"2023-09-26\",\n \"country\": \"US\",\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"stateOrProvinceName\": \"US-AL\"\n },\n \"certificateFingerprint\": \"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311\",\n \"isManaged\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an IACA", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Update the status of an IACA. Only active IACAs can be used for signing mDocs.\n\nCreating an IACA with `active` set to `false` enables distributing the IACA's PEM to relying parties in advance, before it is being used to sign any mDocs.\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_UPDATE_START\n* MOBILE_CREDENTIAL_IACA_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_IACA_UPDATE_FAIL" + }, + "response": [ + { + "name": "IACA updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"bac509a4-6c63-9425-f743-b33d230f9b46\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIICDjCCAbSgAwIBAgIKdeZsA5NPKimuAzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\r\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0zMzA5\\r\\nMDgyMzM0MjJaMCIxIDAJBgNVBAYTAk5aMBMGA1UEAxMMRXhhbXBsZSBJQUNBMFkw\\r\\nEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBbK7JKKFMWuu8kHQK2qaML+MQ0Ykk3Qg\\r\\n/p3TC6lQKvYJozPSpLXbJQIzMPq9u/dG+j4vq1iX/G/jFIwfiEiKEqOB0TCBzjAS\\r\\nBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIABjAdBgNVHQ4EFgQU9zTh\\r\\nKsqFxAgRJDDGW1au+ewJK6owHgYDVR0SBBcwFYYTaHR0cHM6Ly9leGFtcGxlLmNv\\r\\nbTBpBgNVHR8EYjBgMF6gXKBahlhodHRwczovL2V4YW1wbGUuY29tL3YyL2NyZWRl\\r\\nbnRpYWxzL21vYmlsZS9pYWNhcy8yZTg5YzE1Ni0zMWQ1LTQ3ODMtYmQ1OS05MDU1\\r\\nYjVmOGU3ZDIvY3JsMAoGCCqGSM49BAMCA0gAMEUCIQDD+eU8iOsYYC0v41L94fhF\\r\\nZ0brPo4gx2aRxrhE3NLFpwIgIgHCPBXJ+JICJg3K7dEsr153So4SEZzAA1rRn4eF\\r\\nvkM=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"certificateData\": {\n \"notAfter\": \"2034-09-26\",\n \"notBefore\": \"2023-09-26\",\n \"country\": \"US\",\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global IACA\",\n \"stateOrProvinceName\": \"US-AL\"\n },\n \"certificateFingerprint\": \"3c06145a53e6c252091a71540f870d4d521dede9f176a681a74e38ddc47bb311\",\n \"isManaged\": true\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an IACA", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing IACA by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_DELETE_START\n* MOBILE_CREDENTIAL_IACA_DELETE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_IACA_DELETE_LIST_FAIL" + }, + "response": [ + { + "name": "IACA deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "iacas", + ":iacaId" + ], + "variable": [ + { + "key": "iacaId", + "value": "497f6eca-6276-4993-bfeb-53cbbbba6f08", + "description": "(Required) IACA ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing IACAs." + } + ] + } + ] + }, + { + "name": "Digital Trust Service", + "item": [ + { + "name": "Ecosystems", + "item": [ + { + "name": "Retrieve all ecosystems", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of ecosystems.\n### **Analytic events**\n* ECOSYSTEM_RETRIEVE_LIST_START\n* ECOSYSTEM_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Ecosystems retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n ]\n },\n {\n \"id\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n ]\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Create ecosystem", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates an ecosystem.\n### **Analytic events**\n* ECOSYSTEM_CREATE_START\n* ECOSYSTEM_CREATE_SUCCESS\n* ECOSYSTEM_CREATE_FAIL" + }, + "response": [ + { + "name": "Ecosystem created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n },\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n }\n ]\n }\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n },\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n }\n ]\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Sync ecosystem", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/sync", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "sync" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Synchronizes all configured consumptions and integrations by retrieving the most recent trust information.\n### **Analytic events**\n* ECOSYSTEM_TENANT_SYNC_ALL_START\n* ECOSYSTEM_TENANT_SYNC_ALL_SUCCESS\n* ECOSYSTEM_TENANT_SYNC_ALL_FAIL" + }, + "response": [ + { + "name": "Ecosystem sync request accepted.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/sync", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "sync" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"tenantConfiguration\": {\n \"ecosystems\": [\n {\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe\"\n },\n {\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe\"\n }\n ]\n },\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/sync", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "sync" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve ecosystem", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_RETRIEVE_START\n* ECOSYSTEM_RETRIEVE_SUCCESS\n* ECOSYSTEM_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Ecosystem retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n },\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n }\n ]\n }\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n },\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n }\n ]\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update ecosystem", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_UPDATE_START\n* ECOSYSTEM_UPDATE_SUCCESS\n* ECOSYSTEM_UPDATE_FAIL" + }, + "response": [ + { + "name": "Ecosystem updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n },\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n }\n ]\n }\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true,\n \"integrationResult\": {\n \"success\": true,\n \"lastSyncedAt\": \"2024-09-10T02:28:36.550Z\",\n \"lastModifiedAt\": \"2024-08-10T02:28:36.550Z\",\n \"failReasons\": [\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n },\n {\n \"type\": \"UnknownVerificationError\",\n \"message\": \"Unknown verification error occurred\"\n }\n ]\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Ecosystem\",\n \"integrations\": [\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n },\n {\n \"format\": \"MATTR\",\n \"url\": \"https://example.vii.au01.mattr.global/v1/ecosystems/489755c9-1d74-4f59-a127-db7105667bfe/policy\",\n \"enabled\": true\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Delete ecosystem", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_DELETE_START\n* ECOSYSTEM_DELETE_SUCCESS\n* ECOSYSTEM_DELETE_FAIL" + }, + "response": [ + { + "name": "Ecosystem deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for managing ecosystems." + }, + { + "name": "Participants", + "item": [ + { + "name": "Retrieve participants", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of participants from the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_START\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Participants retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n },\n {\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Create participant", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_CREATE_START\n* ECOSYSTEM_PARTICIPANT_CREATE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_CREATE_FAIL" + }, + "response": [ + { + "name": "Participant created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Retrieve participant", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a participant from the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_START\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Participant retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update participant", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates a participant in the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_UPDATE_START\n* ECOSYSTEM_PARTICIPANT_UPDATE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_UPDATE_FAIL" + }, + "response": [ + { + "name": "Participant updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Delete participant", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a participant in the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_DELETE_START\n* ECOSYSTEM_PARTICIPANT_DELETE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_DELETE_FAIL" + }, + "response": [ + { + "name": "Participant deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing ecosystem participants." + }, + { + "name": "Credential types", + "item": [ + { + "name": "Create credential type", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new credential type in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_CREATE_START\n* ECOSYSTEM_CREDENTIAL_CREATE_SUCCESS\n* ECOSYSTEM_CREDENTIAL_CREATE_FAIL" + }, + "response": [ + { + "name": "Credential type created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Retrieve credential types", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of credential types from the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_START\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Credential types retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"compact-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n },\n {\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"compact\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve credential type", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a credential type from the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_START\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_SUCCESS\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Credential type retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete credential type", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a credential type from the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_DELETE_START\n* ECOSYSTEM_CREDENTIAL_DELETE_SUCCESS\n* ECOSYSTEM_CREDENTIAL_DELETE_FAIL" + }, + "response": [ + { + "name": "Credential type deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing ecosystem credential types." + }, + { + "name": "Policy", + "item": [ + { + "name": "Publish policy", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Publish a new version of the ecosystem policy. Only active and currently valid participants and IACA certificates are included in the policy.\n### **Analytic events**\n* ECOSYSTEM_POLICY_CREATE_START\n* ECOSYSTEM_POLICY_CREATE_SUCCESS\n* ECOSYSTEM_POLICY_CREATE_FAIL" + }, + "response": [ + { + "name": "Ecosystem policy published", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"policyPublishedAt\": \"2024-10-22T00:00:00Z\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Retrieve latest ecosystem policy", + "request": { + "method": "GET", + "header": [ + { + "key": "If-None-Match", + "value": "string", + "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." + }, + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an ecosystem policy by providing the ecosystem ID.\n### **Analytic events**\n* ECOSYSTEM_POLICY_RETRIEVE_LATEST_START\n* ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS\n* ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL" + }, + "response": [ + { + "name": "Latest ecosystem policy retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "If-None-Match", + "value": "string", + "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." + }, + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "ETag", + "value": "MTcwMTIyMDgzNzMzOA==", + "description": "An Entity Tag (ETag) is a unique identifier assigned to a specific version of a resource. It allows clients to check if a resource has been modified since it was last retrieved." + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"policyModifiedAt\": \"2023-10-17T00:00:00Z\",\n \"policyPublishedAt\": \"2024-10-22T00:00:00Z\",\n \"credentials\": {\n \"599bf148-d711-405a-a20b-9c8a87ac8850\": {\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n }\n },\n \"participants\": {\n \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\": {\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ],\n \"issuerAllowedCredentials\": [\n \"e0a07846-44e1-41a4-b704-1ccf6eb1a5af\",\n \"25fa6ffc-bf6e-417c-865c-96fcf1d7d1a3\"\n ],\n \"verifierAllowedCredentials\": [\n \"4e25a240-76bb-4e9f-9f93-b93be287922b\",\n \"daca4a43-3ff9-4ecb-93fe-d9104e36bf74\"\n ]\n }\n }\n}" + }, + { + "name": "Not Modified. The resource has not been modified since the last request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "If-None-Match", + "value": "string", + "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." + }, + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Modified", + "code": 304, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "If-None-Match", + "value": "string", + "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." + }, + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "policies", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve ecosystem policy preview", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/preview", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "preview" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an ecosystem policy preview by providing the Ecosystem's ID. A policy preview includes all the participants and credential types created in the ecosystem, excluding any participants with expired or inactive IACAs.\n\n### **Analytic events**\n* ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_START\n* ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_SUCCESS\n* ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Ecosystem policy preview retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/preview", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "preview" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"policyModifiedAt\": \"2023-10-17T00:00:00Z\",\n \"credentials\": {\n \"599bf148-d711-405a-a20b-9c8a87ac8850\": {\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n }\n },\n \"participants\": {\n \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\": {\n \"id\": \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"name\": \"My Participant\",\n \"identifiers\": {\n \"web-semantic\": \"did:web:example.com\",\n \"compact-semantic\": \"did:web:example.com\",\n \"compact\": \"did:web:example.com\",\n \"mobile\": [\n {\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\r\\nMIIBwzCCAWigAwIBAgIKRGC+CqoTGJKkkTAKBggqhkjOPQQDAjAgMR4wCQYDVQQG\\r\\nEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwHhcNMjMwODA4MDAwOTIxWhcNMzMwODA1\\r\\nMDAwOTIxWjAgMR4wCQYDVQQGEwJOWjARBgNVBAMTCk1BVFRSIElBQ0EwWTATBgcq\\r\\nhkjOPQIBBggqhkjOPQMBBwNCAASRu69fzdgM4odkyPtRcZd3eGWCw4BB7StZNGRm\\r\\nuIlrraUyv9SWPHgUYjYmRB1g7ERzj/pOSAspk71Y+QA+j9nPo4GJMIGGMBIGA1Ud\\r\\nEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgAGMB0GA1UdDgQWBBSONcHGh4If\\r\\nO1dYorRpsuFrs+f8SDAcBgNVHRIEFTATgRFpbmZvQG1hdHRyLmdsb2JhbDAjBgNV\\r\\nHR8EHDAaMBiiFoYUaHR0cHM6Ly9tYXR0ci5nbG9iYWwwCgYIKoZIzj0EAwIDSQAw\\r\\nRgIhAPKJIGDSvp7VxRBLCWWeghqi8UUeO+dZsC49TUZcDMNxAiEAoh+7dT+l+GzX\\r\\nk0J2SoGmPiagrbAuIYyTHwzZZuYr1W4=\\r\\n-----END CERTIFICATE-----\\r\\n\",\n \"status\": \"Active\",\n \"validationResult\": {\n \"validated\": true,\n \"failReasons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Active\",\n \"country\": \"US\",\n \"stateOrProvince\": \"US-AL\",\n \"contacts\": [\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n },\n {\n \"phoneNumber\": \"012-3456789\",\n \"address\": \"Participant address\"\n }\n ],\n \"issuerAllowedCredentials\": [\n \"e0a07846-44e1-41a4-b704-1ccf6eb1a5af\",\n \"25fa6ffc-bf6e-417c-865c-96fcf1d7d1a3\"\n ],\n \"verifierAllowedCredentials\": [\n \"4e25a240-76bb-4e9f-9f93-b93be287922b\",\n \"daca4a43-3ff9-4ecb-93fe-d9104e36bf74\"\n ]\n }\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept-Encoding", + "value": "gzip", + "description": "Use the Accept-Encoding header to specify the supported content encodings." + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/preview", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "preview" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for publishing and retrieving an ecosystem policy." + }, + { + "name": "Issuer assignment", + "item": [ + { + "name": "Create issuer assignment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Assigns a credential type to the requested participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_ISSUER_POLICY_CREATE_START\n* ECOSYSTEM_ISSUER_POLICY_CREATE_SUCCESS\n* ECOSYSTEM_ISSUER_POLICY_CREATE_FAIL" + }, + "response": [ + { + "name": "Issuer policy created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Delete issuer assignment", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Removes a credential type to the requested participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_ISSUER_POLICY_DELETE_START\n* ECOSYSTEM_ISSUER_POLICY_DELETE_SUCCESS\n* ECOSYSTEM_ISSUER_POLICY_DELETE_FAIL" + }, + "response": [ + { + "name": "Issuer policy deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "issuer", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for assigning credential types to issuers." + }, + { + "name": "Verifier assignment", + "item": [ + { + "name": "Create verifier assignment", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Assigns a credential type to the requested participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_VERIFIER_POLICY_CREATE_START\n* ECOSYSTEM_VERIFIER_POLICY_CREATE_SUCCESS\n* ECOSYSTEM_VERIFIER_POLICY_CREATE_FAIL" + }, + "response": [ + { + "name": "Verifier policy created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"599bf148-d711-405a-a20b-9c8a87ac8850\",\n \"ecosystemId\": \"87880d7e-a4d0-462e-8383-3f1e5e16865d\",\n \"profile\": \"web-semantic\",\n \"type\": \"DriverLicense\",\n \"name\": \"Driver's License\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentialId\": \"599bf148-d711-405a-a20b-9c8a87ac8850\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Delete verifier assignment", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Removes a credential type from the requested participant in the requested ecosystem..\n### **Analytic events**\n* ECOSYSTEM_VERIFIER_POLICY_DELETE_START\n* ECOSYSTEM_VERIFIER_POLICY_DELETE_SUCCESS\n* ECOSYSTEM_VERIFIER_POLICY_DELETE_FAIL" + }, + "response": [ + { + "name": "Verifier policy deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "participants", + ":participantId", + "verifier", + "credentials", + ":credentialId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "participantId", + "value": "a24e391a-c27f-4b6e-9805-1ee7e03f3c58", + "description": "(Required) The UUID of the participant" + }, + { + "key": "credentialId", + "value": "599bf148-d711-405a-a20b-9c8a87ac8850", + "description": "(Required) The UUID of the credential" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for assigning credential types to verifiers." + }, + { + "name": "Validation", + "item": [ + { + "name": "Validate issuer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "issuer-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Validates that an issuer is allowed to issue a specific credential format according to the ecosystem policy.\n\n### **Analytics events**\n* ECOSYSTEM_VALIDATE_PARTICIPANT_START\n* ECOSYSTEM_VALIDATE_PARTICIPANT_SUCCESS\n* ECOSYSTEM_VALIDATE_PARTICIPANT_FAIL\n" + }, + "response": [ + { + "name": "Validation completed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "issuer-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"validated\": true,\n \"policyVersion\": \"1698371362017\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "issuer-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "issuer-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Validate verifier", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "verifier-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Validates that a verifier is allowed to verify a specific credential format according to the ecosystem policy.\n\n### **Analytics events**\n* ECOSYSTEM_VALIDATE_PARTICIPANT_START\n* ECOSYSTEM_VALIDATE_PARTICIPANT_SUCCESS\n* ECOSYSTEM_VALIDATE_PARTICIPANT_FAIL\n" + }, + "response": [ + { + "name": "Validation completed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "verifier-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"validated\": true,\n \"policyVersion\": \"1698371362017\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "verifier-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"profile\": \"web-semantic\",\n \"identifier\": \"did:example:abcdb1f712ebc6f1c276e12ec21\",\n \"type\": \"DriverLicense\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "verifier-validation" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ] + }, + { + "name": "Certificates", + "item": [ + { + "name": "Create a DTS root CA certificate", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"organisationName\": \"Example Inc.\",\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a DTS root CA certificate which is used to sign DTS signer certificates.\n- A maximum of three DTS root CA certificates can be created per tenant.\n### **Analytic events**\n* ECOSYSTEM_DTS_CA_CERTIFICATE_CREATE_START\n* ECOSYSTEM_DTS_CA_CERTIFICATE_CREATE_SUCCESS\n* ECOSYSTEM_DTS_CA_CERTIFICATE_CREATE_FAIL" + }, + "response": [ + { + "name": "DTS root CA certificate created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"organisationName\": \"Example Inc.\",\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"Example Inc.\"\n },\n \"isManaged\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"organisationName\": \"Example Inc.\",\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"organisationName\": \"Example Inc.\",\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Maximum number of DTS CA certificates reached. Please delete an existing certificate before creating a new one.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"organisationName\": \"Example Inc.\",\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all DTS root CA certificates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all DTS root CA certificates.\n### **Analytic events**\n* ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_LIST_START\n* ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "DTS root CA certificates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"Example Inc.\"\n },\n \"isManaged\": true\n },\n {\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"Example Inc.\"\n },\n \"isManaged\": true\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a DTS root CA certificate", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a DTS root CA certificate.\n### **Analytic events**\n* ECOSYSTEM_DTS_CA_CERTIFICATE_DELETE_START\n* ECOSYSTEM_DTS_CA_CERTIFICATE_DELETE_SUCCESS\n* ECOSYSTEM_DTS_CA_CERTIFICATE_DELETE_FAIL" + }, + "response": [ + { + "name": "DTS root CA certificate deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a DTS root CA certificate", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates a DTS root CA certificate.\n### **Analytic events**\n* ECOSYSTEM_DTS_CA_CERTIFICATE_UPDATE_START\n* ECOSYSTEM_DTS_CA_CERTIFICATE_UPDATE_SUCCESS\n* ECOSYSTEM_DTS_CA_CERTIFICATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "DTS root CA certificate updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"Example Inc.\"\n },\n \"isManaged\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a DTS root CA certificate", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a DTS root CA certificate.\n### **Analytic events**\n* ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_START\n* ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_SUCCESS\n* ECOSYSTEM_DTS_CA_CERTIFICATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "DTS root CA certificate retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"Example Inc.\"\n },\n \"isManaged\": true\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a DTS root CA certificate revocation list", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId/crl", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId", + "crl" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves the revocation list for a given DTS root CA certificate." + }, + "response": [ + { + "name": "DTS root CA certificate revocation list retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId/crl", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId", + "crl" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "\"string\"" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/ca/:dtsCaCertificateId/crl", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "ca", + ":dtsCaCertificateId", + "crl" + ], + "variable": [ + { + "key": "dtsCaCertificateId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the DTS root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all public DTS root CA certificates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/public/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "public", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all public DTS root CA certificates." + }, + "response": [ + { + "name": "Public DTS root CA certificates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/public/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "public", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"rootCertificates\": [\n {\n \"certificate\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"fingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"commonName\": \"example.com\"\n },\n {\n \"certificate\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"fingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"commonName\": \"example.com\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing DTS root CA certificates." + }, + { + "name": "VICAL", + "item": [ + { + "name": "General", + "item": [ + { + "name": "Create VICAL", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a Verified Issuer Certificate Authority List (VICAL) based on the policy of the requested ecosystem. Refer to VICAL ot learn more about the [VICAL](https://learn.mattr.global/docs/digital-trust-service/vical) purpose and data structure." + }, + "response": [ + { + "name": "VICAL created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"vicalIssueID\": 1337,\n \"date\": \"2024-07-28T23:01:13.000Z\"\n}" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Retrieve all VICALs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all VICALs available in the requested ecosystem." + }, + "response": [ + { + "name": "VICALs retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"date\": \"2024-07-28T23:01:13.000Z\",\n \"filename\": \"vical-2024-07-28-1722164473000.cbor\",\n \"isAutoPublished\": false,\n \"vicalIssueID\": 1337\n },\n {\n \"date\": \"2024-07-28T23:01:13.000Z\",\n \"filename\": \"vical-2024-07-28-1722164473000.cbor\",\n \"isAutoPublished\": false,\n \"vicalIssueID\": 1337\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve latest VICAL", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/cbor" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves the latest VICAL from the requested ecosystem." + }, + "response": [ + { + "name": "VICAL retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/cbor" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Disposition", + "value": "attachment; filename=\"vical-2024-07-28-1722164473000.cbor\"", + "description": "Indicates file attachment" + }, + { + "key": "Content-Length", + "value": "1843", + "description": "The size of the file in bytes" + }, + { + "key": "Content-Type", + "value": "application/cbor" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/latest", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public", + "latest" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve specific VICAL", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/cbor" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/:vicalIssueId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public", + ":vicalIssueId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "vicalIssueId", + "value": "1337", + "description": "(Required) Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a specific VICAL from the requested ecosystem by providing the VICAL version identifier." + }, + "response": [ + { + "name": "VICAL retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/cbor" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/:vicalIssueId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public", + ":vicalIssueId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "vicalIssueId", + "value": "1337", + "description": "(Required) Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Disposition", + "value": "attachment; filename=\"vical-2024-07-28-1722164473000.cbor\"", + "description": "Indicates file attachment" + }, + { + "key": "Content-Length", + "value": "1843", + "description": "The size of the file in bytes" + }, + { + "key": "Content-Type", + "value": "application/cbor" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/:vicalIssueId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "public", + ":vicalIssueId" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "vicalIssueId", + "value": "1337", + "description": "(Required) Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for publishing and retrieving an ecosystem policy as a VICAL." + }, + { + "name": "Configuration", + "item": [ + { + "name": "Update VICAL configuration", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"vicalProvider\": \"Mattr\",\n \"autoPublish\": {\n \"enabled\": true,\n \"frequency\": \"Daily\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Update the VICAL configuration for the requested ecosystem" + }, + "response": [ + { + "name": "VICAL configuration updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"vicalProvider\": \"Mattr\",\n \"autoPublish\": {\n \"enabled\": true,\n \"frequency\": \"Daily\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"vicalProvider\": \"Mattr\",\n \"autoPublish\": {\n \"enabled\": true,\n \"frequency\": \"Daily\",\n \"configuredAt\": \"2025-07-01T00:00:00.000Z\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"vicalProvider\": \"Mattr\",\n \"autoPublish\": {\n \"enabled\": true,\n \"frequency\": \"Daily\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve VICAL configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve the VICAL configuration from the requested ecosystem" + }, + "response": [ + { + "name": "VICAL configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"vicalProvider\": \"Mattr\",\n \"autoPublish\": {\n \"enabled\": true,\n \"frequency\": \"Daily\",\n \"configuredAt\": \"2025-07-01T00:00:00.000Z\"\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete VICAL configuration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Delete the VICAL configuration for the requested ecosystem" + }, + "response": [ + { + "name": "VICAL configuration deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + ":ecosystemId", + "vicals", + "configuration" + ], + "variable": [ + { + "key": "ecosystemId", + "value": "87880d7e-a4d0-462e-8383-3f1e5e16865d", + "description": "(Required) The UUID of the ecosystem" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing VICAL configuration." + }, + { + "name": "Signers", + "item": [ + { + "name": "Create a VICAL signer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a VICAL signer.\n- Only available in implementations using unmanaged (external) DTS root CA certificates.\n- A maximum of five VICAL signers can be created per tenant.\n\n### **Analytic events**\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_START\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_SUCCESS\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_FAIL" + }, + "response": [ + { + "name": "VICAL signer created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE REQUEST-----\",\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\",\n \"active\": false\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Maximum number of VICAL signer certificates reached. Please delete an existing certificate before creating a new one.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all VICAL signers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all VICAL signers.\n### **Analytic events**\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_START\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "VICAL signers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n }\n },\n {\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n }\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a VICAL signer", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates a VICAL signer by:\n- Providing a VICAL Signer Certificate (VSC) in PEM format that matches its Certificate Signing Request (CSR).\n- Activating or deactivating the VICAL signer. Only VICAL signers with a valid PEM certificate can be activated.\n- The `certificatePem` field becomes immutable after it's updated for the first time.\n\n> Only available in implementations using unmanaged (external) DTS root CA certificates.\n\n### **Analytic events**\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_START\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESS\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "VICAL signer updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a VICAL signer", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a VICAL signer.\n\n> Only available in implementations using unmanaged (external) DTS root CA certificates.\n\n### **Analytic events**\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_START\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_SUCCESS\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_FAIL" + }, + "response": [ + { + "name": "VICAL signer deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a VICAL signer", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a VICAL signer.\n### **Analytic events**\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_START\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS\n* ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "VICAL signer retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\"\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/ecosystems/certificates/vical-signers/:vicalSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "ecosystems", + "certificates", + "vical-signers", + ":vicalSignerId" + ], + "variable": [ + { + "key": "vicalSignerId", + "value": "123e4567-e89b-12d3-a456-426614174000", + "description": "(Required) Unique identifier of the VICAL signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing VICAL signers." + } + ] + } + ] + }, + { + "name": "Credential issuance", + "item": [ + { + "name": "OID4VCI", + "item": [ + { + "name": "Authentication Provider", + "item": [ + { + "name": "Configure an Authentication Provider", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"url\": \"https://example-university.au.auth0.com\",\n \"clientSecret\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Configures an Authentication Provider on the tenant.\n\nAn authentication or identity provider (IdP) is a platform that is typically used to store and manage user accounts on behalf of an organization or a service provider. MATTR VII uses the authentication provider to authenticate end users before issuing them credentials.\n\n> Only one authentication provider can be configured on a tenant.\n\nThe `/.well-known/openid-configuration` endpoint of the Authentication Provider must contain values for the `authorization_endpoint`, `token_endpoint` and `scopes_supported`.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_CREATE_START\n* USER_AUTHENTICATION_PROVIDER_CREATE_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_CREATE_FAIL" + }, + "response": [ + { + "name": "Authentication Provider configured", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"url\": \"https://example-university.au.auth0.com\",\n \"clientSecret\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"clientId\": \"vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN\",\n \"clientSecret\": \"***********************************************************6-OjH\",\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"redirectUrl\": \"https://tenant.vii.mattr.global/v1/oauth/authentication/callback\",\n \"url\": \"http://WQEZeQLIREJbYu.sizjhRzBDG6UdHUgr0zWwadzmtcH+M6Lm2zX\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"staticRequestParameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": \"string\",\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": \"string\",\n \"key_18\": \"string\",\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": \"string\",\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": \"string\",\n \"key_34\": \"string\",\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": \"string\",\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": \"string\",\n \"key_47\": \"string\",\n \"key_48\": \"string\",\n \"key_49\": \"string\",\n \"key_50\": \"string\",\n \"key_51\": \"string\",\n \"key_52\": \"string\",\n \"key_53\": \"string\",\n \"key_54\": \"string\",\n \"key_55\": \"string\",\n \"key_56\": \"string\",\n \"key_57\": \"string\",\n \"key_58\": \"string\",\n \"key_59\": \"string\",\n \"key_60\": \"string\",\n \"key_61\": \"string\",\n \"key_62\": \"string\",\n \"key_63\": \"string\",\n \"key_64\": \"string\",\n \"key_65\": \"string\",\n \"key_66\": \"string\",\n \"key_67\": \"string\",\n \"key_68\": \"string\",\n \"key_69\": \"string\",\n \"key_70\": \"string\",\n \"key_71\": \"string\",\n \"key_72\": \"string\",\n \"key_73\": \"string\",\n \"key_74\": \"string\",\n \"key_75\": \"string\",\n \"key_76\": \"string\",\n \"key_77\": \"string\",\n \"key_78\": \"string\",\n \"key_79\": \"string\",\n \"key_80\": \"string\",\n \"key_81\": \"string\",\n \"key_82\": \"string\",\n \"key_83\": \"string\",\n \"key_84\": \"string\",\n \"key_85\": \"string\",\n \"key_86\": \"string\",\n \"key_87\": \"string\",\n \"key_88\": \"string\",\n \"key_89\": \"string\",\n \"key_90\": \"string\",\n \"key_91\": \"string\",\n \"key_92\": \"string\",\n \"key_93\": \"string\",\n \"key_94\": \"string\",\n \"key_95\": \"string\",\n \"key_96\": \"string\",\n \"key_97\": \"string\",\n \"key_98\": \"string\",\n \"key_99\": \"string\",\n \"key_100\": \"string\",\n \"key_101\": \"string\",\n \"key_102\": \"string\",\n \"key_103\": \"string\",\n \"key_104\": \"string\",\n \"key_105\": \"string\",\n \"key_106\": \"string\",\n \"key_107\": \"string\",\n \"key_108\": \"string\",\n \"key_109\": \"string\",\n \"key_110\": \"string\",\n \"key_111\": \"string\",\n \"key_112\": \"string\",\n \"key_113\": \"string\",\n \"key_114\": \"string\",\n \"key_115\": \"string\",\n \"key_116\": \"string\",\n \"key_117\": \"string\",\n \"key_118\": \"string\",\n \"key_119\": \"string\",\n \"key_120\": \"string\",\n \"key_121\": \"string\",\n \"key_122\": \"string\",\n \"key_123\": \"string\",\n \"key_124\": \"string\",\n \"key_125\": \"string\",\n \"key_126\": \"string\",\n \"key_127\": \"string\",\n \"key_128\": \"string\",\n \"key_129\": \"string\",\n \"key_130\": \"string\",\n \"key_131\": \"string\",\n \"key_132\": \"string\",\n \"key_133\": \"string\",\n \"key_134\": \"string\",\n \"key_135\": \"string\",\n \"key_136\": \"string\",\n \"key_137\": \"string\",\n \"key_138\": \"string\",\n \"key_139\": \"string\",\n \"key_140\": \"string\",\n \"key_141\": \"string\",\n \"key_142\": \"string\",\n \"key_143\": \"string\",\n \"key_144\": \"string\",\n \"key_145\": \"string\",\n \"key_146\": \"string\",\n \"key_147\": \"string\",\n \"key_148\": \"string\",\n \"key_149\": \"string\",\n \"key_150\": \"string\",\n \"key_151\": \"string\",\n \"key_152\": \"string\",\n \"key_153\": \"string\",\n \"key_154\": \"string\",\n \"key_155\": \"string\",\n \"key_156\": \"string\",\n \"key_157\": \"string\",\n \"key_158\": \"string\",\n \"key_159\": \"string\",\n \"key_160\": \"string\",\n \"key_161\": \"string\",\n \"key_162\": \"string\",\n \"key_163\": \"string\",\n \"key_164\": \"string\",\n \"key_165\": \"string\",\n \"key_166\": \"string\",\n \"key_167\": \"string\",\n \"key_168\": \"string\",\n \"key_169\": \"string\",\n \"key_170\": \"string\",\n \"key_171\": \"string\",\n \"key_172\": \"string\",\n \"key_173\": \"string\",\n \"key_174\": \"string\",\n \"key_175\": \"string\",\n \"key_176\": \"string\",\n \"key_177\": \"string\",\n \"key_178\": \"string\",\n \"key_179\": \"string\",\n \"key_180\": \"string\",\n \"key_181\": \"string\",\n \"key_182\": \"string\",\n \"key_183\": \"string\",\n \"key_184\": \"string\",\n \"key_185\": \"string\",\n \"key_186\": \"string\",\n \"key_187\": \"string\",\n \"key_188\": \"string\",\n \"key_189\": \"string\",\n \"key_190\": \"string\",\n \"key_191\": \"string\",\n \"key_192\": \"string\",\n \"key_193\": \"string\",\n \"key_194\": \"string\",\n \"key_195\": \"string\",\n \"key_196\": \"string\",\n \"key_197\": \"string\",\n \"key_198\": \"string\",\n \"key_199\": \"string\",\n \"key_200\": \"string\",\n \"key_201\": \"string\",\n \"key_202\": \"string\",\n \"key_203\": \"string\",\n \"key_204\": \"string\",\n \"key_205\": \"string\",\n \"key_206\": \"string\",\n \"key_207\": \"string\",\n \"key_208\": \"string\",\n \"key_209\": \"string\",\n \"key_210\": \"string\",\n \"key_211\": \"string\",\n \"key_212\": \"string\",\n \"key_213\": \"string\",\n \"key_214\": \"string\",\n \"key_215\": \"string\",\n \"key_216\": \"string\",\n \"key_217\": \"string\",\n \"key_218\": \"string\",\n \"key_219\": \"string\",\n \"key_220\": \"string\",\n \"key_221\": \"string\",\n \"key_222\": \"string\",\n \"key_223\": \"string\",\n \"key_224\": \"string\",\n \"key_225\": \"string\",\n \"key_226\": \"string\",\n \"key_227\": \"string\",\n \"key_228\": \"string\",\n \"key_229\": \"string\",\n \"key_230\": \"string\",\n \"key_231\": \"string\",\n \"key_232\": \"string\",\n \"key_233\": \"string\",\n \"key_234\": \"string\",\n \"key_235\": \"string\",\n \"key_236\": \"string\",\n \"key_237\": \"string\",\n \"key_238\": \"string\",\n \"key_239\": \"string\",\n \"key_240\": \"string\",\n \"key_241\": \"string\",\n \"key_242\": \"string\",\n \"key_243\": \"string\",\n \"key_244\": \"string\",\n \"key_245\": \"string\",\n \"key_246\": \"string\",\n \"key_247\": \"string\",\n \"key_248\": \"string\",\n \"key_249\": \"string\",\n \"key_250\": \"string\",\n \"key_251\": \"string\",\n \"key_252\": \"string\",\n \"key_253\": \"string\",\n \"key_254\": \"string\",\n \"key_255\": \"string\",\n \"key_256\": \"string\",\n \"key_257\": \"string\",\n \"key_258\": \"string\",\n \"key_259\": \"string\",\n \"key_260\": \"string\",\n \"key_261\": \"string\",\n \"key_262\": \"string\",\n \"key_263\": \"string\",\n \"key_264\": \"string\",\n \"key_265\": \"string\",\n \"key_266\": \"string\",\n \"key_267\": \"string\",\n \"key_268\": \"string\",\n \"key_269\": \"string\",\n \"key_270\": \"string\",\n \"key_271\": \"string\",\n \"key_272\": \"string\",\n \"key_273\": \"string\",\n \"key_274\": \"string\",\n \"key_275\": \"string\",\n \"key_276\": \"string\",\n \"key_277\": \"string\",\n \"key_278\": \"string\",\n \"key_279\": \"string\",\n \"key_280\": \"string\",\n \"key_281\": \"string\",\n \"key_282\": \"string\",\n \"key_283\": \"string\",\n \"key_284\": \"string\",\n \"key_285\": \"string\",\n \"key_286\": \"string\",\n \"key_287\": \"string\",\n \"key_288\": \"string\",\n \"key_289\": \"string\",\n \"key_290\": \"string\",\n \"key_291\": \"string\",\n \"key_292\": \"string\",\n \"key_293\": \"string\",\n \"key_294\": \"string\",\n \"key_295\": \"string\",\n \"key_296\": \"string\",\n \"key_297\": \"string\",\n \"key_298\": \"string\",\n \"key_299\": \"string\",\n \"key_300\": \"string\",\n \"key_301\": \"string\",\n \"key_302\": \"string\",\n \"key_303\": \"string\",\n \"key_304\": \"string\",\n \"key_305\": \"string\",\n \"key_306\": \"string\",\n \"key_307\": \"string\",\n \"key_308\": \"string\",\n \"key_309\": \"string\",\n \"key_310\": \"string\",\n \"key_311\": \"string\",\n \"key_312\": \"string\",\n \"key_313\": \"string\",\n \"key_314\": \"string\",\n \"key_315\": \"string\",\n \"key_316\": \"string\",\n \"key_317\": \"string\",\n \"key_318\": \"string\",\n \"key_319\": \"string\",\n \"key_320\": \"string\",\n \"key_321\": \"string\",\n \"key_322\": \"string\",\n \"key_323\": \"string\",\n \"key_324\": \"string\",\n \"key_325\": \"string\",\n \"key_326\": \"string\",\n \"key_327\": \"string\",\n \"key_328\": \"string\",\n \"key_329\": \"string\",\n \"key_330\": \"string\",\n \"key_331\": \"string\",\n \"key_332\": \"string\",\n \"key_333\": \"string\",\n \"key_334\": \"string\",\n \"key_335\": \"string\",\n \"key_336\": \"string\",\n \"key_337\": \"string\",\n \"key_338\": \"string\",\n \"key_339\": \"string\",\n \"key_340\": \"string\",\n \"key_341\": \"string\",\n \"key_342\": \"string\",\n \"key_343\": \"string\",\n \"key_344\": \"string\",\n \"key_345\": \"string\",\n \"key_346\": \"string\",\n \"key_347\": \"string\",\n \"key_348\": \"string\",\n \"key_349\": \"string\",\n \"key_350\": \"string\",\n \"key_351\": \"string\",\n \"key_352\": \"string\",\n \"key_353\": \"string\",\n \"key_354\": \"string\",\n \"key_355\": \"string\",\n \"key_356\": \"string\",\n \"key_357\": \"string\",\n \"key_358\": \"string\",\n \"key_359\": \"string\",\n \"key_360\": \"string\",\n \"key_361\": \"string\",\n \"key_362\": \"string\",\n \"key_363\": \"string\",\n \"key_364\": \"string\",\n \"key_365\": \"string\",\n \"key_366\": \"string\",\n \"key_367\": \"string\",\n \"key_368\": \"string\",\n \"key_369\": \"string\",\n \"key_370\": \"string\",\n \"key_371\": \"string\",\n \"key_372\": \"string\",\n \"key_373\": \"string\",\n \"key_374\": \"string\",\n \"key_375\": \"string\",\n \"key_376\": \"string\",\n \"key_377\": \"string\",\n \"key_378\": \"string\",\n \"key_379\": \"string\",\n \"key_380\": \"string\",\n \"key_381\": \"string\",\n \"key_382\": \"string\",\n \"key_383\": \"string\",\n \"key_384\": \"string\",\n \"key_385\": \"string\",\n \"key_386\": \"string\",\n \"key_387\": \"string\",\n \"key_388\": \"string\",\n \"key_389\": \"string\",\n \"key_390\": \"string\",\n \"key_391\": \"string\",\n \"key_392\": \"string\",\n \"key_393\": \"string\",\n \"key_394\": \"string\",\n \"key_395\": \"string\",\n \"key_396\": \"string\",\n \"key_397\": \"string\",\n \"key_398\": \"string\",\n \"key_399\": \"string\",\n \"key_400\": \"string\",\n \"key_401\": \"string\",\n \"key_402\": \"string\",\n \"key_403\": \"string\",\n \"key_404\": \"string\",\n \"key_405\": \"string\",\n \"key_406\": \"string\",\n \"key_407\": \"string\",\n \"key_408\": \"string\",\n \"key_409\": \"string\",\n \"key_410\": \"string\",\n \"key_411\": \"string\",\n \"key_412\": \"string\",\n \"key_413\": \"string\",\n \"key_414\": \"string\",\n \"key_415\": \"string\",\n \"key_416\": \"string\",\n \"key_417\": \"string\",\n \"key_418\": \"string\",\n \"key_419\": \"string\",\n \"key_420\": \"string\",\n \"key_421\": \"string\",\n \"key_422\": \"string\",\n \"key_423\": \"string\",\n \"key_424\": \"string\",\n \"key_425\": \"string\",\n \"key_426\": \"string\",\n \"key_427\": \"string\",\n \"key_428\": \"string\",\n \"key_429\": \"string\",\n \"key_430\": \"string\",\n \"key_431\": \"string\",\n \"key_432\": \"string\",\n \"key_433\": \"string\",\n \"key_434\": \"string\",\n \"key_435\": \"string\",\n \"key_436\": \"string\",\n \"key_437\": \"string\",\n \"key_438\": \"string\",\n \"key_439\": \"string\",\n \"key_440\": \"string\",\n \"key_441\": \"string\",\n \"key_442\": \"string\",\n \"key_443\": \"string\",\n \"key_444\": \"string\",\n \"key_445\": \"string\",\n \"key_446\": \"string\",\n \"key_447\": \"string\",\n \"key_448\": \"string\",\n \"key_449\": \"string\",\n \"key_450\": \"string\",\n \"key_451\": \"string\",\n \"key_452\": \"string\",\n \"key_453\": \"string\",\n \"key_454\": \"string\",\n \"key_455\": \"string\",\n \"key_456\": \"string\",\n \"key_457\": \"string\",\n \"key_458\": \"string\",\n \"key_459\": \"string\",\n \"key_460\": \"string\",\n \"key_461\": \"string\",\n \"key_462\": \"string\",\n \"key_463\": \"string\",\n \"key_464\": \"string\",\n \"key_465\": \"string\",\n \"key_466\": \"string\",\n \"key_467\": \"string\",\n \"key_468\": \"string\",\n \"key_469\": \"string\",\n \"key_470\": \"string\",\n \"key_471\": \"string\",\n \"key_472\": \"string\",\n \"key_473\": \"string\",\n \"key_474\": \"string\",\n \"key_475\": \"string\",\n \"key_476\": \"string\",\n \"key_477\": \"string\",\n \"key_478\": \"string\",\n \"key_479\": \"string\",\n \"key_480\": \"string\",\n \"key_481\": \"string\",\n \"key_482\": \"string\",\n \"key_483\": \"string\",\n \"key_484\": \"string\",\n \"key_485\": \"string\",\n \"key_486\": \"string\",\n \"key_487\": \"string\",\n \"key_488\": \"string\",\n \"key_489\": \"string\",\n \"key_490\": \"string\",\n \"key_491\": \"string\",\n \"key_492\": \"string\",\n \"key_493\": \"string\",\n \"key_494\": \"string\",\n \"key_495\": \"string\",\n \"key_496\": \"string\",\n \"key_497\": \"string\",\n \"key_498\": \"string\",\n \"key_499\": \"string\",\n \"key_500\": \"string\",\n \"key_501\": \"string\",\n \"key_502\": \"string\",\n \"key_503\": \"string\",\n \"key_504\": \"string\",\n \"key_505\": \"string\",\n \"key_506\": \"string\",\n \"key_507\": \"string\",\n \"key_508\": \"string\",\n \"key_509\": \"string\",\n \"key_510\": \"string\",\n \"key_511\": \"string\",\n \"key_512\": \"string\",\n \"key_513\": \"string\",\n \"key_514\": \"string\",\n \"key_515\": \"string\",\n \"key_516\": \"string\",\n \"key_517\": \"string\",\n \"key_518\": \"string\",\n \"key_519\": \"string\",\n \"key_520\": \"string\",\n \"key_521\": \"string\",\n \"key_522\": \"string\",\n \"key_523\": \"string\",\n \"key_524\": \"string\",\n \"key_525\": \"string\",\n \"key_526\": \"string\",\n \"key_527\": \"string\",\n \"key_528\": \"string\",\n \"key_529\": \"string\",\n \"key_530\": \"string\",\n \"key_531\": \"string\",\n \"key_532\": \"string\",\n \"key_533\": \"string\",\n \"key_534\": \"string\",\n \"key_535\": \"string\",\n \"key_536\": \"string\",\n \"key_537\": \"string\",\n \"key_538\": \"string\",\n \"key_539\": \"string\",\n \"key_540\": \"string\",\n \"key_541\": \"string\",\n \"key_542\": \"string\",\n \"key_543\": \"string\",\n \"key_544\": \"string\",\n \"key_545\": \"string\",\n \"key_546\": \"string\",\n \"key_547\": \"string\",\n \"key_548\": \"string\",\n \"key_549\": \"string\",\n \"key_550\": \"string\",\n \"key_551\": \"string\",\n \"key_552\": \"string\",\n \"key_553\": \"string\",\n \"key_554\": \"string\",\n \"key_555\": \"string\",\n \"key_556\": \"string\",\n \"key_557\": \"string\",\n \"key_558\": \"string\",\n \"key_559\": \"string\",\n \"key_560\": \"string\",\n \"key_561\": \"string\",\n \"key_562\": \"string\",\n \"key_563\": \"string\",\n \"key_564\": \"string\",\n \"key_565\": \"string\",\n \"key_566\": \"string\",\n \"key_567\": \"string\",\n \"key_568\": \"string\",\n \"key_569\": \"string\",\n \"key_570\": \"string\",\n \"key_571\": \"string\",\n \"key_572\": \"string\",\n \"key_573\": \"string\",\n \"key_574\": \"string\",\n \"key_575\": \"string\",\n \"key_576\": \"string\",\n \"key_577\": \"string\",\n \"key_578\": \"string\",\n \"key_579\": \"string\",\n \"key_580\": \"string\",\n \"key_581\": \"string\",\n \"key_582\": \"string\",\n \"key_583\": \"string\",\n \"key_584\": \"string\",\n \"key_585\": \"string\",\n \"key_586\": \"string\",\n \"key_587\": \"string\",\n \"key_588\": \"string\",\n \"key_589\": \"string\",\n \"key_590\": \"string\",\n \"key_591\": \"string\",\n \"key_592\": \"string\",\n \"key_593\": \"string\",\n \"key_594\": \"string\",\n \"key_595\": \"string\",\n \"key_596\": \"string\",\n \"key_597\": \"string\",\n \"key_598\": \"string\",\n \"key_599\": \"string\",\n \"key_600\": \"string\",\n \"key_601\": \"string\",\n \"key_602\": \"string\",\n \"key_603\": \"string\",\n \"key_604\": \"string\",\n \"key_605\": \"string\",\n \"key_606\": \"string\",\n \"key_607\": \"string\",\n \"key_608\": \"string\",\n \"key_609\": \"string\",\n \"key_610\": \"string\",\n \"key_611\": \"string\",\n \"key_612\": \"string\",\n \"key_613\": \"string\",\n \"key_614\": \"string\",\n \"key_615\": \"string\",\n \"key_616\": \"string\",\n \"key_617\": \"string\",\n \"key_618\": \"string\",\n \"key_619\": \"string\",\n \"key_620\": \"string\",\n \"key_621\": \"string\",\n \"key_622\": \"string\",\n \"key_623\": \"string\",\n \"key_624\": \"string\",\n \"key_625\": \"string\",\n \"key_626\": \"string\",\n \"key_627\": \"string\",\n \"key_628\": \"string\",\n \"key_629\": \"string\",\n \"key_630\": \"string\",\n \"key_631\": \"string\",\n \"key_632\": \"string\",\n \"key_633\": \"string\",\n \"key_634\": \"string\",\n \"key_635\": \"string\",\n \"key_636\": \"string\",\n \"key_637\": \"string\",\n \"key_638\": \"string\",\n \"key_639\": \"string\",\n \"key_640\": \"string\",\n \"key_641\": \"string\",\n \"key_642\": \"string\",\n \"key_643\": \"string\",\n \"key_644\": \"string\",\n \"key_645\": \"string\",\n \"key_646\": \"string\",\n \"key_647\": \"string\",\n \"key_648\": \"string\",\n \"key_649\": \"string\",\n \"key_650\": \"string\",\n \"key_651\": \"string\",\n \"key_652\": \"string\",\n \"key_653\": \"string\",\n \"key_654\": \"string\",\n \"key_655\": \"string\",\n \"key_656\": \"string\",\n \"key_657\": \"string\",\n \"key_658\": \"string\",\n \"key_659\": \"string\",\n \"key_660\": \"string\",\n \"key_661\": \"string\",\n \"key_662\": \"string\",\n \"key_663\": \"string\",\n \"key_664\": \"string\",\n \"key_665\": \"string\",\n \"key_666\": \"string\",\n \"key_667\": \"string\",\n \"key_668\": \"string\",\n \"key_669\": \"string\",\n \"key_670\": \"string\",\n \"key_671\": \"string\",\n \"key_672\": \"string\",\n \"key_673\": \"string\",\n \"key_674\": \"string\",\n \"key_675\": \"string\",\n \"key_676\": \"string\",\n \"key_677\": \"string\",\n \"key_678\": \"string\",\n \"key_679\": \"string\",\n \"key_680\": \"string\",\n \"key_681\": \"string\",\n \"key_682\": \"string\",\n \"key_683\": \"string\",\n \"key_684\": \"string\",\n \"key_685\": \"string\",\n \"key_686\": \"string\",\n \"key_687\": \"string\",\n \"key_688\": \"string\",\n \"key_689\": \"string\",\n \"key_690\": \"string\",\n \"key_691\": \"string\",\n \"key_692\": \"string\",\n \"key_693\": \"string\",\n \"key_694\": \"string\",\n \"key_695\": \"string\",\n \"key_696\": \"string\",\n \"key_697\": \"string\",\n \"key_698\": \"string\",\n \"key_699\": \"string\",\n \"key_700\": \"string\",\n \"key_701\": \"string\",\n \"key_702\": \"string\",\n \"key_703\": \"string\",\n \"key_704\": \"string\",\n \"key_705\": \"string\",\n \"key_706\": \"string\",\n \"key_707\": \"string\",\n \"key_708\": \"string\",\n \"key_709\": \"string\",\n \"key_710\": \"string\",\n \"key_711\": \"string\",\n \"key_712\": \"string\",\n \"key_713\": \"string\",\n \"key_714\": \"string\",\n \"key_715\": \"string\",\n \"key_716\": \"string\",\n \"key_717\": \"string\",\n \"key_718\": \"string\",\n \"key_719\": \"string\",\n \"key_720\": \"string\",\n \"key_721\": \"string\",\n \"key_722\": \"string\",\n \"key_723\": \"string\",\n \"key_724\": \"string\",\n \"key_725\": \"string\",\n \"key_726\": \"string\",\n \"key_727\": \"string\",\n \"key_728\": \"string\",\n \"key_729\": \"string\",\n \"key_730\": \"string\",\n \"key_731\": \"string\",\n \"key_732\": \"string\",\n \"key_733\": \"string\",\n \"key_734\": \"string\",\n \"key_735\": \"string\",\n \"key_736\": \"string\",\n \"key_737\": \"string\",\n \"key_738\": \"string\",\n \"key_739\": \"string\",\n \"key_740\": \"string\",\n \"key_741\": \"string\",\n \"key_742\": \"string\",\n \"key_743\": \"string\",\n \"key_744\": \"string\",\n \"key_745\": \"string\",\n \"key_746\": \"string\",\n \"key_747\": \"string\",\n \"key_748\": \"string\",\n \"key_749\": \"string\",\n \"key_750\": \"string\",\n \"key_751\": \"string\",\n \"key_752\": \"string\",\n \"key_753\": \"string\",\n \"key_754\": \"string\",\n \"key_755\": \"string\",\n \"key_756\": \"string\",\n \"key_757\": \"string\",\n \"key_758\": \"string\",\n \"key_759\": \"string\",\n \"key_760\": \"string\",\n \"key_761\": \"string\",\n \"key_762\": \"string\",\n \"key_763\": \"string\",\n \"key_764\": \"string\",\n \"key_765\": \"string\",\n \"key_766\": \"string\",\n \"key_767\": \"string\",\n \"key_768\": \"string\",\n \"key_769\": \"string\",\n \"key_770\": \"string\",\n \"key_771\": \"string\",\n \"key_772\": \"string\",\n \"key_773\": \"string\",\n \"key_774\": \"string\",\n \"key_775\": \"string\",\n \"key_776\": \"string\",\n \"key_777\": \"string\",\n \"key_778\": \"string\",\n \"key_779\": \"string\",\n \"key_780\": \"string\",\n \"key_781\": \"string\",\n \"key_782\": \"string\",\n \"key_783\": \"string\",\n \"key_784\": \"string\",\n \"key_785\": \"string\",\n \"key_786\": \"string\",\n \"key_787\": \"string\",\n \"key_788\": \"string\",\n \"key_789\": \"string\",\n \"key_790\": \"string\",\n \"key_791\": \"string\",\n \"key_792\": \"string\",\n \"key_793\": \"string\",\n \"key_794\": \"string\",\n \"key_795\": \"string\",\n \"key_796\": \"string\",\n \"key_797\": \"string\",\n \"key_798\": \"string\",\n \"key_799\": \"string\",\n \"key_800\": \"string\",\n \"key_801\": \"string\",\n \"key_802\": \"string\",\n \"key_803\": \"string\",\n \"key_804\": \"string\",\n \"key_805\": \"string\",\n \"key_806\": \"string\",\n \"key_807\": \"string\",\n \"key_808\": \"string\",\n \"key_809\": \"string\",\n \"key_810\": \"string\",\n \"key_811\": \"string\",\n \"key_812\": \"string\",\n \"key_813\": \"string\",\n \"key_814\": \"string\",\n \"key_815\": \"string\",\n \"key_816\": \"string\",\n \"key_817\": \"string\",\n \"key_818\": \"string\",\n \"key_819\": \"string\",\n \"key_820\": \"string\",\n \"key_821\": \"string\",\n \"key_822\": \"string\",\n \"key_823\": \"string\",\n \"key_824\": \"string\",\n \"key_825\": \"string\",\n \"key_826\": \"string\",\n \"key_827\": \"string\",\n \"key_828\": \"string\",\n \"key_829\": \"string\",\n \"key_830\": \"string\",\n \"key_831\": \"string\",\n \"key_832\": \"string\",\n \"key_833\": \"string\",\n \"key_834\": \"string\",\n \"key_835\": \"string\",\n \"key_836\": \"string\",\n \"key_837\": \"string\",\n \"key_838\": \"string\",\n \"key_839\": \"string\",\n \"key_840\": \"string\",\n \"key_841\": \"string\",\n \"key_842\": \"string\",\n \"key_843\": \"string\",\n \"key_844\": \"string\",\n \"key_845\": \"string\",\n \"key_846\": \"string\",\n \"key_847\": \"string\",\n \"key_848\": \"string\",\n \"key_849\": \"string\",\n \"key_850\": \"string\",\n \"key_851\": \"string\",\n \"key_852\": \"string\",\n \"key_853\": \"string\",\n \"key_854\": \"string\",\n \"key_855\": \"string\",\n \"key_856\": \"string\",\n \"key_857\": \"string\",\n \"key_858\": \"string\",\n \"key_859\": \"string\",\n \"key_860\": \"string\",\n \"key_861\": \"string\",\n \"key_862\": \"string\",\n \"key_863\": \"string\",\n \"key_864\": \"string\",\n \"key_865\": \"string\",\n \"key_866\": \"string\",\n \"key_867\": \"string\",\n \"key_868\": \"string\",\n \"key_869\": \"string\",\n \"key_870\": \"string\",\n \"key_871\": \"string\",\n \"key_872\": \"string\",\n \"key_873\": \"string\",\n \"key_874\": \"string\",\n \"key_875\": \"string\",\n \"key_876\": \"string\",\n \"key_877\": \"string\",\n \"key_878\": \"string\",\n \"key_879\": \"string\",\n \"key_880\": \"string\",\n \"key_881\": \"string\",\n \"key_882\": \"string\",\n \"key_883\": \"string\",\n \"key_884\": \"string\",\n \"key_885\": \"string\",\n \"key_886\": \"string\",\n \"key_887\": \"string\",\n \"key_888\": \"string\",\n \"key_889\": \"string\",\n \"key_890\": \"string\",\n \"key_891\": \"string\",\n \"key_892\": \"string\",\n \"key_893\": \"string\",\n \"key_894\": \"string\",\n \"key_895\": \"string\",\n \"key_896\": \"string\",\n \"key_897\": \"string\",\n \"key_898\": \"string\",\n \"key_899\": \"string\",\n \"key_900\": \"string\",\n \"key_901\": \"string\",\n \"key_902\": \"string\",\n \"key_903\": \"string\",\n \"key_904\": \"string\",\n \"key_905\": \"string\",\n \"key_906\": \"string\",\n \"key_907\": \"string\",\n \"key_908\": \"string\",\n \"key_909\": \"string\",\n \"key_910\": \"string\",\n \"key_911\": \"string\",\n \"key_912\": \"string\",\n \"key_913\": \"string\",\n \"key_914\": \"string\",\n \"key_915\": \"string\",\n \"key_916\": \"string\",\n \"key_917\": \"string\",\n \"key_918\": \"string\",\n \"key_919\": \"string\",\n \"key_920\": \"string\",\n \"key_921\": \"string\",\n \"key_922\": \"string\",\n \"key_923\": \"string\",\n \"key_924\": \"string\",\n \"key_925\": \"string\",\n \"key_926\": \"string\",\n \"key_927\": \"string\",\n \"key_928\": \"string\",\n \"key_929\": \"string\",\n \"key_930\": \"string\",\n \"key_931\": \"string\",\n \"key_932\": \"string\",\n \"key_933\": \"string\",\n \"key_934\": \"string\",\n \"key_935\": \"string\",\n \"key_936\": \"string\",\n \"key_937\": \"string\",\n \"key_938\": \"string\",\n \"key_939\": \"string\",\n \"key_940\": \"string\",\n \"key_941\": \"string\",\n \"key_942\": \"string\",\n \"key_943\": \"string\",\n \"key_944\": \"string\",\n \"key_945\": \"string\",\n \"key_946\": \"string\",\n \"key_947\": \"string\",\n \"key_948\": \"string\",\n \"key_949\": \"string\",\n \"key_950\": \"string\",\n \"key_951\": \"string\",\n \"key_952\": \"string\",\n \"key_953\": \"string\",\n \"key_954\": \"string\",\n \"key_955\": \"string\",\n \"key_956\": \"string\",\n \"key_957\": \"string\",\n \"key_958\": \"string\",\n \"key_959\": \"string\",\n \"key_960\": \"string\",\n \"key_961\": \"string\",\n \"key_962\": \"string\",\n \"key_963\": \"string\",\n \"key_964\": \"string\",\n \"key_965\": \"string\",\n \"key_966\": \"string\",\n \"key_967\": \"string\",\n \"key_968\": \"string\",\n \"key_969\": \"string\",\n \"key_970\": \"string\",\n \"key_971\": \"string\",\n \"key_972\": \"string\",\n \"key_973\": \"string\",\n \"key_974\": \"string\",\n \"key_975\": \"string\",\n \"key_976\": \"string\",\n \"key_977\": \"string\",\n \"key_978\": \"string\",\n \"key_979\": \"string\",\n \"key_980\": \"string\",\n \"key_981\": \"string\",\n \"key_982\": \"string\",\n \"key_983\": \"string\",\n \"key_984\": \"string\"\n },\n \"forwardedRequestParameters\": [\n \"login_hint\"\n ],\n \"claimsToPersist\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"url\": \"https://example-university.au.auth0.com\",\n \"clientSecret\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Authentication Providers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all Authentication Providers on your tenant.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_START\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Authentication Providers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"clientId\": \"vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN\",\n \"clientSecret\": \"***********************************************************6-OjH\",\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"redirectUrl\": \"https://tenant.vii.mattr.global/v1/oauth/authentication/callback\",\n \"url\": \"https://tFKsdrELIubtKRzB.yeiOhnMDIuuZNjTSThs+iLwSXVf4D.6gcIT2NJrmJU,iZbEMAQPezg\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"staticRequestParameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": \"string\",\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": \"string\",\n \"key_18\": \"string\",\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": \"string\",\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": \"string\",\n \"key_34\": \"string\",\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": \"string\",\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": \"string\",\n \"key_47\": \"string\",\n \"key_48\": \"string\",\n \"key_49\": \"string\",\n \"key_50\": \"string\",\n \"key_51\": \"string\",\n \"key_52\": \"string\",\n \"key_53\": \"string\",\n \"key_54\": \"string\",\n \"key_55\": \"string\",\n \"key_56\": \"string\",\n \"key_57\": \"string\",\n \"key_58\": \"string\",\n \"key_59\": \"string\",\n \"key_60\": \"string\",\n \"key_61\": \"string\",\n \"key_62\": \"string\",\n \"key_63\": \"string\",\n \"key_64\": \"string\",\n \"key_65\": \"string\",\n \"key_66\": \"string\",\n \"key_67\": \"string\",\n \"key_68\": \"string\",\n \"key_69\": \"string\",\n \"key_70\": \"string\",\n \"key_71\": \"string\",\n \"key_72\": \"string\",\n \"key_73\": \"string\",\n \"key_74\": \"string\",\n \"key_75\": \"string\",\n \"key_76\": \"string\",\n \"key_77\": \"string\",\n \"key_78\": \"string\",\n \"key_79\": \"string\",\n \"key_80\": \"string\",\n \"key_81\": \"string\",\n \"key_82\": \"string\",\n \"key_83\": \"string\",\n \"key_84\": \"string\",\n \"key_85\": \"string\",\n \"key_86\": \"string\",\n \"key_87\": \"string\",\n \"key_88\": \"string\",\n \"key_89\": \"string\",\n \"key_90\": \"string\",\n \"key_91\": \"string\",\n \"key_92\": \"string\",\n \"key_93\": \"string\",\n \"key_94\": \"string\",\n \"key_95\": \"string\",\n \"key_96\": \"string\",\n \"key_97\": \"string\",\n \"key_98\": \"string\",\n \"key_99\": \"string\",\n \"key_100\": \"string\",\n \"key_101\": \"string\",\n \"key_102\": \"string\",\n \"key_103\": \"string\",\n \"key_104\": \"string\",\n \"key_105\": \"string\",\n \"key_106\": \"string\",\n \"key_107\": \"string\",\n \"key_108\": \"string\",\n \"key_109\": \"string\",\n \"key_110\": \"string\",\n \"key_111\": \"string\",\n \"key_112\": \"string\",\n \"key_113\": \"string\",\n \"key_114\": \"string\",\n \"key_115\": \"string\",\n \"key_116\": \"string\",\n \"key_117\": \"string\",\n \"key_118\": \"string\",\n \"key_119\": \"string\",\n \"key_120\": \"string\",\n \"key_121\": \"string\",\n \"key_122\": \"string\",\n \"key_123\": \"string\",\n \"key_124\": \"string\",\n \"key_125\": \"string\",\n \"key_126\": \"string\",\n \"key_127\": \"string\",\n \"key_128\": \"string\",\n \"key_129\": \"string\",\n \"key_130\": \"string\",\n \"key_131\": \"string\",\n \"key_132\": \"string\",\n \"key_133\": \"string\",\n \"key_134\": \"string\",\n \"key_135\": \"string\",\n \"key_136\": \"string\",\n \"key_137\": \"string\",\n \"key_138\": \"string\",\n \"key_139\": \"string\",\n \"key_140\": \"string\",\n \"key_141\": \"string\",\n \"key_142\": \"string\",\n \"key_143\": \"string\",\n \"key_144\": \"string\",\n \"key_145\": \"string\",\n \"key_146\": \"string\",\n \"key_147\": \"string\",\n \"key_148\": \"string\",\n \"key_149\": \"string\",\n \"key_150\": \"string\",\n \"key_151\": \"string\",\n \"key_152\": \"string\",\n \"key_153\": \"string\",\n \"key_154\": \"string\",\n \"key_155\": \"string\",\n \"key_156\": \"string\",\n \"key_157\": \"string\",\n \"key_158\": \"string\",\n \"key_159\": \"string\",\n \"key_160\": \"string\",\n \"key_161\": \"string\",\n \"key_162\": \"string\",\n \"key_163\": \"string\",\n \"key_164\": \"string\",\n \"key_165\": \"string\",\n \"key_166\": \"string\",\n \"key_167\": \"string\",\n \"key_168\": \"string\",\n \"key_169\": \"string\",\n \"key_170\": \"string\",\n \"key_171\": \"string\",\n \"key_172\": \"string\",\n \"key_173\": \"string\",\n \"key_174\": \"string\",\n \"key_175\": \"string\",\n \"key_176\": \"string\",\n \"key_177\": \"string\",\n \"key_178\": \"string\",\n \"key_179\": \"string\",\n \"key_180\": \"string\",\n \"key_181\": \"string\",\n \"key_182\": \"string\",\n \"key_183\": \"string\",\n \"key_184\": \"string\",\n \"key_185\": \"string\",\n \"key_186\": \"string\",\n \"key_187\": \"string\",\n \"key_188\": \"string\",\n \"key_189\": \"string\",\n \"key_190\": \"string\",\n \"key_191\": \"string\",\n \"key_192\": \"string\",\n \"key_193\": \"string\",\n \"key_194\": \"string\",\n \"key_195\": \"string\",\n \"key_196\": \"string\",\n \"key_197\": \"string\",\n \"key_198\": \"string\",\n \"key_199\": \"string\",\n \"key_200\": \"string\",\n \"key_201\": \"string\",\n \"key_202\": \"string\",\n \"key_203\": \"string\",\n \"key_204\": \"string\",\n \"key_205\": \"string\",\n \"key_206\": \"string\",\n \"key_207\": \"string\",\n \"key_208\": \"string\",\n \"key_209\": \"string\",\n \"key_210\": \"string\",\n \"key_211\": \"string\",\n \"key_212\": \"string\",\n \"key_213\": \"string\",\n \"key_214\": \"string\",\n \"key_215\": \"string\",\n \"key_216\": \"string\",\n \"key_217\": \"string\",\n \"key_218\": \"string\",\n \"key_219\": \"string\",\n \"key_220\": \"string\",\n \"key_221\": \"string\",\n \"key_222\": \"string\",\n \"key_223\": \"string\",\n \"key_224\": \"string\",\n \"key_225\": \"string\",\n \"key_226\": \"string\",\n \"key_227\": \"string\",\n \"key_228\": \"string\",\n \"key_229\": \"string\",\n \"key_230\": \"string\",\n \"key_231\": \"string\",\n \"key_232\": \"string\",\n \"key_233\": \"string\",\n \"key_234\": \"string\",\n \"key_235\": \"string\",\n \"key_236\": \"string\",\n \"key_237\": \"string\",\n \"key_238\": \"string\",\n \"key_239\": \"string\",\n \"key_240\": \"string\",\n \"key_241\": \"string\",\n \"key_242\": \"string\",\n \"key_243\": \"string\",\n \"key_244\": \"string\",\n \"key_245\": \"string\",\n \"key_246\": \"string\",\n \"key_247\": \"string\",\n \"key_248\": \"string\",\n \"key_249\": \"string\",\n \"key_250\": \"string\",\n \"key_251\": \"string\",\n \"key_252\": \"string\",\n \"key_253\": \"string\",\n \"key_254\": \"string\",\n \"key_255\": \"string\",\n \"key_256\": \"string\",\n \"key_257\": \"string\",\n \"key_258\": \"string\",\n \"key_259\": \"string\",\n \"key_260\": \"string\",\n \"key_261\": \"string\",\n \"key_262\": \"string\",\n \"key_263\": \"string\",\n \"key_264\": \"string\",\n \"key_265\": \"string\",\n \"key_266\": \"string\",\n \"key_267\": \"string\",\n \"key_268\": \"string\",\n \"key_269\": \"string\",\n \"key_270\": \"string\",\n \"key_271\": \"string\",\n \"key_272\": \"string\",\n \"key_273\": \"string\",\n \"key_274\": \"string\",\n \"key_275\": \"string\",\n \"key_276\": \"string\",\n \"key_277\": \"string\",\n \"key_278\": \"string\",\n \"key_279\": \"string\",\n \"key_280\": \"string\",\n \"key_281\": \"string\",\n \"key_282\": \"string\",\n \"key_283\": \"string\",\n \"key_284\": \"string\",\n \"key_285\": \"string\",\n \"key_286\": \"string\",\n \"key_287\": \"string\",\n \"key_288\": \"string\",\n \"key_289\": \"string\",\n \"key_290\": \"string\",\n \"key_291\": \"string\",\n \"key_292\": \"string\",\n \"key_293\": \"string\",\n \"key_294\": \"string\",\n \"key_295\": \"string\",\n \"key_296\": \"string\",\n \"key_297\": \"string\",\n \"key_298\": \"string\",\n \"key_299\": \"string\",\n \"key_300\": \"string\",\n \"key_301\": \"string\",\n \"key_302\": \"string\",\n \"key_303\": \"string\",\n \"key_304\": \"string\",\n \"key_305\": \"string\",\n \"key_306\": \"string\",\n \"key_307\": \"string\",\n \"key_308\": \"string\",\n \"key_309\": \"string\",\n \"key_310\": \"string\",\n \"key_311\": \"string\",\n \"key_312\": \"string\",\n \"key_313\": \"string\",\n \"key_314\": \"string\",\n \"key_315\": \"string\",\n \"key_316\": \"string\",\n \"key_317\": \"string\",\n \"key_318\": \"string\",\n \"key_319\": \"string\",\n \"key_320\": \"string\",\n \"key_321\": \"string\",\n \"key_322\": \"string\",\n \"key_323\": \"string\",\n \"key_324\": \"string\",\n \"key_325\": \"string\",\n \"key_326\": \"string\",\n \"key_327\": \"string\",\n \"key_328\": \"string\",\n \"key_329\": \"string\",\n \"key_330\": \"string\",\n \"key_331\": \"string\",\n \"key_332\": \"string\",\n \"key_333\": \"string\",\n \"key_334\": \"string\",\n \"key_335\": \"string\",\n \"key_336\": \"string\",\n \"key_337\": \"string\",\n \"key_338\": \"string\",\n \"key_339\": \"string\",\n \"key_340\": \"string\",\n \"key_341\": \"string\",\n \"key_342\": \"string\",\n \"key_343\": \"string\",\n \"key_344\": \"string\",\n \"key_345\": \"string\",\n \"key_346\": \"string\",\n \"key_347\": \"string\",\n \"key_348\": \"string\",\n \"key_349\": \"string\",\n \"key_350\": \"string\",\n \"key_351\": \"string\",\n \"key_352\": \"string\",\n \"key_353\": \"string\",\n \"key_354\": \"string\",\n \"key_355\": \"string\",\n \"key_356\": \"string\",\n \"key_357\": \"string\",\n \"key_358\": \"string\",\n \"key_359\": \"string\",\n \"key_360\": \"string\",\n \"key_361\": \"string\",\n \"key_362\": \"string\",\n \"key_363\": \"string\",\n \"key_364\": \"string\",\n \"key_365\": \"string\",\n \"key_366\": \"string\",\n \"key_367\": \"string\",\n \"key_368\": \"string\",\n \"key_369\": \"string\",\n \"key_370\": \"string\",\n \"key_371\": \"string\",\n \"key_372\": \"string\",\n \"key_373\": \"string\",\n \"key_374\": \"string\",\n \"key_375\": \"string\",\n \"key_376\": \"string\",\n \"key_377\": \"string\",\n \"key_378\": \"string\",\n \"key_379\": \"string\",\n \"key_380\": \"string\",\n \"key_381\": \"string\",\n \"key_382\": \"string\",\n \"key_383\": \"string\",\n \"key_384\": \"string\",\n \"key_385\": \"string\",\n \"key_386\": \"string\",\n \"key_387\": \"string\",\n \"key_388\": \"string\",\n \"key_389\": \"string\",\n \"key_390\": \"string\",\n \"key_391\": \"string\",\n \"key_392\": \"string\",\n \"key_393\": \"string\",\n \"key_394\": \"string\",\n \"key_395\": \"string\",\n \"key_396\": \"string\",\n \"key_397\": \"string\",\n \"key_398\": \"string\",\n \"key_399\": \"string\",\n \"key_400\": \"string\",\n \"key_401\": \"string\",\n \"key_402\": \"string\",\n \"key_403\": \"string\",\n \"key_404\": \"string\",\n \"key_405\": \"string\",\n \"key_406\": \"string\",\n \"key_407\": \"string\",\n \"key_408\": \"string\",\n \"key_409\": \"string\",\n \"key_410\": \"string\",\n \"key_411\": \"string\",\n \"key_412\": \"string\",\n \"key_413\": \"string\",\n \"key_414\": \"string\",\n \"key_415\": \"string\",\n \"key_416\": \"string\",\n \"key_417\": \"string\",\n \"key_418\": \"string\",\n \"key_419\": \"string\",\n \"key_420\": \"string\",\n \"key_421\": \"string\",\n \"key_422\": \"string\",\n \"key_423\": \"string\",\n \"key_424\": \"string\",\n \"key_425\": \"string\",\n \"key_426\": \"string\",\n \"key_427\": \"string\",\n \"key_428\": \"string\",\n \"key_429\": \"string\",\n \"key_430\": \"string\",\n \"key_431\": \"string\",\n \"key_432\": \"string\",\n \"key_433\": \"string\",\n \"key_434\": \"string\",\n \"key_435\": \"string\",\n \"key_436\": \"string\",\n \"key_437\": \"string\",\n \"key_438\": \"string\",\n \"key_439\": \"string\",\n \"key_440\": \"string\",\n \"key_441\": \"string\",\n \"key_442\": \"string\",\n \"key_443\": \"string\",\n \"key_444\": \"string\",\n \"key_445\": \"string\",\n \"key_446\": \"string\",\n \"key_447\": \"string\",\n \"key_448\": \"string\",\n \"key_449\": \"string\",\n \"key_450\": \"string\",\n \"key_451\": \"string\",\n \"key_452\": \"string\",\n \"key_453\": \"string\",\n \"key_454\": \"string\",\n \"key_455\": \"string\",\n \"key_456\": \"string\",\n \"key_457\": \"string\",\n \"key_458\": \"string\",\n \"key_459\": \"string\",\n \"key_460\": \"string\",\n \"key_461\": \"string\",\n \"key_462\": \"string\",\n \"key_463\": \"string\",\n \"key_464\": \"string\",\n \"key_465\": \"string\",\n \"key_466\": \"string\",\n \"key_467\": \"string\",\n \"key_468\": \"string\",\n \"key_469\": \"string\",\n \"key_470\": \"string\",\n \"key_471\": \"string\",\n \"key_472\": \"string\",\n \"key_473\": \"string\",\n \"key_474\": \"string\",\n \"key_475\": \"string\",\n \"key_476\": \"string\",\n \"key_477\": \"string\",\n \"key_478\": \"string\",\n \"key_479\": \"string\",\n \"key_480\": \"string\",\n \"key_481\": \"string\",\n \"key_482\": \"string\",\n \"key_483\": \"string\",\n \"key_484\": \"string\",\n \"key_485\": \"string\",\n \"key_486\": \"string\",\n \"key_487\": \"string\",\n \"key_488\": \"string\",\n \"key_489\": \"string\",\n \"key_490\": \"string\",\n \"key_491\": \"string\",\n \"key_492\": \"string\",\n \"key_493\": \"string\",\n \"key_494\": \"string\",\n \"key_495\": \"string\",\n \"key_496\": \"string\",\n \"key_497\": \"string\",\n \"key_498\": \"string\",\n \"key_499\": \"string\",\n \"key_500\": \"string\",\n \"key_501\": \"string\",\n \"key_502\": \"string\",\n \"key_503\": \"string\",\n \"key_504\": \"string\",\n \"key_505\": \"string\",\n \"key_506\": \"string\",\n \"key_507\": \"string\"\n },\n \"forwardedRequestParameters\": [\n \"login_hint\"\n ],\n \"claimsToPersist\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ]\n },\n {\n \"clientId\": \"vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN\",\n \"clientSecret\": \"***********************************************************6-OjH\",\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"redirectUrl\": \"https://tenant.vii.mattr.global/v1/oauth/authentication/callback\",\n \"url\": \"https://EVDcqxeuvRVONO.ipgF8FsZ5bm2QA1Z.WblJyNio,TQNJP6arPovF7aN-Nzh-pVL\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"staticRequestParameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": \"string\",\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": \"string\",\n \"key_18\": \"string\",\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": \"string\",\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": \"string\",\n \"key_34\": \"string\",\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": \"string\",\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": \"string\",\n \"key_47\": \"string\",\n \"key_48\": \"string\",\n \"key_49\": \"string\",\n \"key_50\": \"string\",\n \"key_51\": \"string\",\n \"key_52\": \"string\",\n \"key_53\": \"string\",\n \"key_54\": \"string\",\n \"key_55\": \"string\",\n \"key_56\": \"string\",\n \"key_57\": \"string\",\n \"key_58\": \"string\",\n \"key_59\": \"string\",\n \"key_60\": \"string\",\n \"key_61\": \"string\",\n \"key_62\": \"string\",\n \"key_63\": \"string\",\n \"key_64\": \"string\",\n \"key_65\": \"string\",\n \"key_66\": \"string\",\n \"key_67\": \"string\",\n \"key_68\": \"string\",\n \"key_69\": \"string\",\n \"key_70\": \"string\",\n \"key_71\": \"string\",\n \"key_72\": \"string\",\n \"key_73\": \"string\",\n \"key_74\": \"string\",\n \"key_75\": \"string\",\n \"key_76\": \"string\",\n \"key_77\": \"string\",\n \"key_78\": \"string\",\n \"key_79\": \"string\",\n \"key_80\": \"string\",\n \"key_81\": \"string\",\n \"key_82\": \"string\",\n \"key_83\": \"string\",\n \"key_84\": \"string\",\n \"key_85\": \"string\",\n \"key_86\": \"string\",\n \"key_87\": \"string\",\n \"key_88\": \"string\",\n \"key_89\": \"string\",\n \"key_90\": \"string\",\n \"key_91\": \"string\",\n \"key_92\": \"string\",\n \"key_93\": \"string\",\n \"key_94\": \"string\",\n \"key_95\": \"string\",\n \"key_96\": \"string\",\n \"key_97\": \"string\",\n \"key_98\": \"string\",\n \"key_99\": \"string\",\n \"key_100\": \"string\",\n \"key_101\": \"string\",\n \"key_102\": \"string\",\n \"key_103\": \"string\",\n \"key_104\": \"string\",\n \"key_105\": \"string\",\n \"key_106\": \"string\",\n \"key_107\": \"string\",\n \"key_108\": \"string\",\n \"key_109\": \"string\",\n \"key_110\": \"string\",\n \"key_111\": \"string\",\n \"key_112\": \"string\",\n \"key_113\": \"string\",\n \"key_114\": \"string\",\n \"key_115\": \"string\",\n \"key_116\": \"string\",\n \"key_117\": \"string\",\n \"key_118\": \"string\",\n \"key_119\": \"string\",\n \"key_120\": \"string\",\n \"key_121\": \"string\",\n \"key_122\": \"string\",\n \"key_123\": \"string\",\n \"key_124\": \"string\",\n \"key_125\": \"string\",\n \"key_126\": \"string\",\n \"key_127\": \"string\",\n \"key_128\": \"string\",\n \"key_129\": \"string\",\n \"key_130\": \"string\",\n \"key_131\": \"string\",\n \"key_132\": \"string\",\n \"key_133\": \"string\",\n \"key_134\": \"string\",\n \"key_135\": \"string\",\n \"key_136\": \"string\",\n \"key_137\": \"string\",\n \"key_138\": \"string\",\n \"key_139\": \"string\",\n \"key_140\": \"string\",\n \"key_141\": \"string\",\n \"key_142\": \"string\",\n \"key_143\": \"string\",\n \"key_144\": \"string\",\n \"key_145\": \"string\",\n \"key_146\": \"string\",\n \"key_147\": \"string\",\n \"key_148\": \"string\",\n \"key_149\": \"string\",\n \"key_150\": \"string\",\n \"key_151\": \"string\",\n \"key_152\": \"string\",\n \"key_153\": \"string\",\n \"key_154\": \"string\",\n \"key_155\": \"string\",\n \"key_156\": \"string\",\n \"key_157\": \"string\",\n \"key_158\": \"string\",\n \"key_159\": \"string\",\n \"key_160\": \"string\",\n \"key_161\": \"string\",\n \"key_162\": \"string\",\n \"key_163\": \"string\",\n \"key_164\": \"string\",\n \"key_165\": \"string\",\n \"key_166\": \"string\",\n \"key_167\": \"string\",\n \"key_168\": \"string\",\n \"key_169\": \"string\",\n \"key_170\": \"string\",\n \"key_171\": \"string\",\n \"key_172\": \"string\",\n \"key_173\": \"string\",\n \"key_174\": \"string\",\n \"key_175\": \"string\",\n \"key_176\": \"string\",\n \"key_177\": \"string\",\n \"key_178\": \"string\",\n \"key_179\": \"string\",\n \"key_180\": \"string\",\n \"key_181\": \"string\",\n \"key_182\": \"string\",\n \"key_183\": \"string\",\n \"key_184\": \"string\",\n \"key_185\": \"string\",\n \"key_186\": \"string\",\n \"key_187\": \"string\",\n \"key_188\": \"string\",\n \"key_189\": \"string\",\n \"key_190\": \"string\",\n \"key_191\": \"string\",\n \"key_192\": \"string\",\n \"key_193\": \"string\",\n \"key_194\": \"string\",\n \"key_195\": \"string\",\n \"key_196\": \"string\",\n \"key_197\": \"string\",\n \"key_198\": \"string\",\n \"key_199\": \"string\",\n \"key_200\": \"string\",\n \"key_201\": \"string\",\n \"key_202\": \"string\",\n \"key_203\": \"string\",\n \"key_204\": \"string\",\n \"key_205\": \"string\",\n \"key_206\": \"string\",\n \"key_207\": \"string\",\n \"key_208\": \"string\",\n \"key_209\": \"string\",\n \"key_210\": \"string\",\n \"key_211\": \"string\",\n \"key_212\": \"string\",\n \"key_213\": \"string\",\n \"key_214\": \"string\",\n \"key_215\": \"string\",\n \"key_216\": \"string\",\n \"key_217\": \"string\",\n \"key_218\": \"string\",\n \"key_219\": \"string\",\n \"key_220\": \"string\",\n \"key_221\": \"string\",\n \"key_222\": \"string\",\n \"key_223\": \"string\",\n \"key_224\": \"string\",\n \"key_225\": \"string\",\n \"key_226\": \"string\",\n \"key_227\": \"string\",\n \"key_228\": \"string\",\n \"key_229\": \"string\",\n \"key_230\": \"string\",\n \"key_231\": \"string\",\n \"key_232\": \"string\",\n \"key_233\": \"string\",\n \"key_234\": \"string\",\n \"key_235\": \"string\",\n \"key_236\": \"string\",\n \"key_237\": \"string\",\n \"key_238\": \"string\",\n \"key_239\": \"string\",\n \"key_240\": \"string\",\n \"key_241\": \"string\",\n \"key_242\": \"string\",\n \"key_243\": \"string\",\n \"key_244\": \"string\",\n \"key_245\": \"string\",\n \"key_246\": \"string\",\n \"key_247\": \"string\",\n \"key_248\": \"string\",\n \"key_249\": \"string\",\n \"key_250\": \"string\",\n \"key_251\": \"string\",\n \"key_252\": \"string\",\n \"key_253\": \"string\",\n \"key_254\": \"string\",\n \"key_255\": \"string\",\n \"key_256\": \"string\",\n \"key_257\": \"string\",\n \"key_258\": \"string\",\n \"key_259\": \"string\",\n \"key_260\": \"string\",\n \"key_261\": \"string\",\n \"key_262\": \"string\",\n \"key_263\": \"string\",\n \"key_264\": \"string\",\n \"key_265\": \"string\",\n \"key_266\": \"string\",\n \"key_267\": \"string\",\n \"key_268\": \"string\",\n \"key_269\": \"string\",\n \"key_270\": \"string\",\n \"key_271\": \"string\",\n \"key_272\": \"string\",\n \"key_273\": \"string\",\n \"key_274\": \"string\",\n \"key_275\": \"string\",\n \"key_276\": \"string\",\n \"key_277\": \"string\",\n \"key_278\": \"string\",\n \"key_279\": \"string\",\n \"key_280\": \"string\",\n \"key_281\": \"string\",\n \"key_282\": \"string\",\n \"key_283\": \"string\",\n \"key_284\": \"string\",\n \"key_285\": \"string\",\n \"key_286\": \"string\",\n \"key_287\": \"string\",\n \"key_288\": \"string\",\n \"key_289\": \"string\",\n \"key_290\": \"string\",\n \"key_291\": \"string\",\n \"key_292\": \"string\",\n \"key_293\": \"string\",\n \"key_294\": \"string\",\n \"key_295\": \"string\",\n \"key_296\": \"string\",\n \"key_297\": \"string\",\n \"key_298\": \"string\",\n \"key_299\": \"string\",\n \"key_300\": \"string\",\n \"key_301\": \"string\",\n \"key_302\": \"string\",\n \"key_303\": \"string\",\n \"key_304\": \"string\",\n \"key_305\": \"string\",\n \"key_306\": \"string\",\n \"key_307\": \"string\",\n \"key_308\": \"string\",\n \"key_309\": \"string\",\n \"key_310\": \"string\",\n \"key_311\": \"string\",\n \"key_312\": \"string\",\n \"key_313\": \"string\",\n \"key_314\": \"string\",\n \"key_315\": \"string\",\n \"key_316\": \"string\",\n \"key_317\": \"string\",\n \"key_318\": \"string\",\n \"key_319\": \"string\",\n \"key_320\": \"string\",\n \"key_321\": \"string\",\n \"key_322\": \"string\",\n \"key_323\": \"string\",\n \"key_324\": \"string\",\n \"key_325\": \"string\",\n \"key_326\": \"string\",\n \"key_327\": \"string\",\n \"key_328\": \"string\",\n \"key_329\": \"string\",\n \"key_330\": \"string\",\n \"key_331\": \"string\",\n \"key_332\": \"string\",\n \"key_333\": \"string\",\n \"key_334\": \"string\",\n \"key_335\": \"string\",\n \"key_336\": \"string\",\n \"key_337\": \"string\",\n \"key_338\": \"string\",\n \"key_339\": \"string\",\n \"key_340\": \"string\",\n \"key_341\": \"string\",\n \"key_342\": \"string\",\n \"key_343\": \"string\",\n \"key_344\": \"string\",\n \"key_345\": \"string\",\n \"key_346\": \"string\",\n \"key_347\": \"string\",\n \"key_348\": \"string\",\n \"key_349\": \"string\",\n \"key_350\": \"string\",\n \"key_351\": \"string\",\n \"key_352\": \"string\",\n \"key_353\": \"string\",\n \"key_354\": \"string\",\n \"key_355\": \"string\",\n \"key_356\": \"string\",\n \"key_357\": \"string\",\n \"key_358\": \"string\",\n \"key_359\": \"string\",\n \"key_360\": \"string\",\n \"key_361\": \"string\",\n \"key_362\": \"string\",\n \"key_363\": \"string\",\n \"key_364\": \"string\",\n \"key_365\": \"string\",\n \"key_366\": \"string\",\n \"key_367\": \"string\",\n \"key_368\": \"string\",\n \"key_369\": \"string\",\n \"key_370\": \"string\",\n \"key_371\": \"string\",\n \"key_372\": \"string\",\n \"key_373\": \"string\",\n \"key_374\": \"string\",\n \"key_375\": \"string\",\n \"key_376\": \"string\",\n \"key_377\": \"string\",\n \"key_378\": \"string\",\n \"key_379\": \"string\",\n \"key_380\": \"string\",\n \"key_381\": \"string\",\n \"key_382\": \"string\",\n \"key_383\": \"string\",\n \"key_384\": \"string\",\n \"key_385\": \"string\",\n \"key_386\": \"string\",\n \"key_387\": \"string\",\n \"key_388\": \"string\",\n \"key_389\": \"string\",\n \"key_390\": \"string\",\n \"key_391\": \"string\",\n \"key_392\": \"string\",\n \"key_393\": \"string\",\n \"key_394\": \"string\",\n \"key_395\": \"string\",\n \"key_396\": \"string\",\n \"key_397\": \"string\",\n \"key_398\": \"string\",\n \"key_399\": \"string\",\n \"key_400\": \"string\",\n \"key_401\": \"string\",\n \"key_402\": \"string\",\n \"key_403\": \"string\",\n \"key_404\": \"string\",\n \"key_405\": \"string\",\n \"key_406\": \"string\",\n \"key_407\": \"string\",\n \"key_408\": \"string\",\n \"key_409\": \"string\",\n \"key_410\": \"string\",\n \"key_411\": \"string\",\n \"key_412\": \"string\",\n \"key_413\": \"string\",\n \"key_414\": \"string\",\n \"key_415\": \"string\",\n \"key_416\": \"string\",\n \"key_417\": \"string\",\n \"key_418\": \"string\",\n \"key_419\": \"string\",\n \"key_420\": \"string\",\n \"key_421\": \"string\",\n \"key_422\": \"string\",\n \"key_423\": \"string\",\n \"key_424\": \"string\",\n \"key_425\": \"string\",\n \"key_426\": \"string\",\n \"key_427\": \"string\",\n \"key_428\": \"string\",\n \"key_429\": \"string\",\n \"key_430\": \"string\",\n \"key_431\": \"string\",\n \"key_432\": \"string\",\n \"key_433\": \"string\",\n \"key_434\": \"string\",\n \"key_435\": \"string\",\n \"key_436\": \"string\",\n \"key_437\": \"string\",\n \"key_438\": \"string\",\n \"key_439\": \"string\",\n \"key_440\": \"string\",\n \"key_441\": \"string\",\n \"key_442\": \"string\",\n \"key_443\": \"string\",\n \"key_444\": \"string\",\n \"key_445\": \"string\",\n \"key_446\": \"string\",\n \"key_447\": \"string\",\n \"key_448\": \"string\",\n \"key_449\": \"string\",\n \"key_450\": \"string\",\n \"key_451\": \"string\",\n \"key_452\": \"string\",\n \"key_453\": \"string\",\n \"key_454\": \"string\",\n \"key_455\": \"string\",\n \"key_456\": \"string\",\n \"key_457\": \"string\",\n \"key_458\": \"string\",\n \"key_459\": \"string\",\n \"key_460\": \"string\",\n \"key_461\": \"string\",\n \"key_462\": \"string\",\n \"key_463\": \"string\",\n \"key_464\": \"string\",\n \"key_465\": \"string\",\n \"key_466\": \"string\",\n \"key_467\": \"string\",\n \"key_468\": \"string\",\n \"key_469\": \"string\",\n \"key_470\": \"string\",\n \"key_471\": \"string\",\n \"key_472\": \"string\",\n \"key_473\": \"string\",\n \"key_474\": \"string\",\n \"key_475\": \"string\",\n \"key_476\": \"string\",\n \"key_477\": \"string\",\n \"key_478\": \"string\",\n \"key_479\": \"string\",\n \"key_480\": \"string\",\n \"key_481\": \"string\",\n \"key_482\": \"string\",\n \"key_483\": \"string\",\n \"key_484\": \"string\",\n \"key_485\": \"string\",\n \"key_486\": \"string\",\n \"key_487\": \"string\",\n \"key_488\": \"string\",\n \"key_489\": \"string\",\n \"key_490\": \"string\",\n \"key_491\": \"string\",\n \"key_492\": \"string\",\n \"key_493\": \"string\",\n \"key_494\": \"string\",\n \"key_495\": \"string\",\n \"key_496\": \"string\",\n \"key_497\": \"string\",\n \"key_498\": \"string\",\n \"key_499\": \"string\",\n \"key_500\": \"string\",\n \"key_501\": \"string\",\n \"key_502\": \"string\",\n \"key_503\": \"string\",\n \"key_504\": \"string\",\n \"key_505\": \"string\",\n \"key_506\": \"string\",\n \"key_507\": \"string\",\n \"key_508\": \"string\",\n \"key_509\": \"string\",\n \"key_510\": \"string\",\n \"key_511\": \"string\",\n \"key_512\": \"string\",\n \"key_513\": \"string\",\n \"key_514\": \"string\",\n \"key_515\": \"string\",\n \"key_516\": \"string\",\n \"key_517\": \"string\",\n \"key_518\": \"string\",\n \"key_519\": \"string\",\n \"key_520\": \"string\",\n \"key_521\": \"string\",\n \"key_522\": \"string\",\n \"key_523\": \"string\",\n \"key_524\": \"string\",\n \"key_525\": \"string\",\n \"key_526\": \"string\",\n \"key_527\": \"string\",\n \"key_528\": \"string\",\n \"key_529\": \"string\",\n \"key_530\": \"string\",\n \"key_531\": \"string\",\n \"key_532\": \"string\",\n \"key_533\": \"string\",\n \"key_534\": \"string\",\n \"key_535\": \"string\",\n \"key_536\": \"string\",\n \"key_537\": \"string\",\n \"key_538\": \"string\",\n \"key_539\": \"string\",\n \"key_540\": \"string\",\n \"key_541\": \"string\",\n \"key_542\": \"string\",\n \"key_543\": \"string\",\n \"key_544\": \"string\",\n \"key_545\": \"string\",\n \"key_546\": \"string\",\n \"key_547\": \"string\",\n \"key_548\": \"string\",\n \"key_549\": \"string\",\n \"key_550\": \"string\",\n \"key_551\": \"string\",\n \"key_552\": \"string\",\n \"key_553\": \"string\",\n \"key_554\": \"string\",\n \"key_555\": \"string\",\n \"key_556\": \"string\",\n \"key_557\": \"string\",\n \"key_558\": \"string\",\n \"key_559\": \"string\",\n \"key_560\": \"string\",\n \"key_561\": \"string\",\n \"key_562\": \"string\",\n \"key_563\": \"string\",\n \"key_564\": \"string\",\n \"key_565\": \"string\",\n \"key_566\": \"string\",\n \"key_567\": \"string\",\n \"key_568\": \"string\",\n \"key_569\": \"string\",\n \"key_570\": \"string\",\n \"key_571\": \"string\",\n \"key_572\": \"string\",\n \"key_573\": \"string\",\n \"key_574\": \"string\",\n \"key_575\": \"string\",\n \"key_576\": \"string\",\n \"key_577\": \"string\",\n \"key_578\": \"string\",\n \"key_579\": \"string\",\n \"key_580\": \"string\",\n \"key_581\": \"string\",\n \"key_582\": \"string\",\n \"key_583\": \"string\",\n \"key_584\": \"string\",\n \"key_585\": \"string\",\n \"key_586\": \"string\",\n \"key_587\": \"string\",\n \"key_588\": \"string\",\n \"key_589\": \"string\",\n \"key_590\": \"string\",\n \"key_591\": \"string\",\n \"key_592\": \"string\",\n \"key_593\": \"string\",\n \"key_594\": \"string\",\n \"key_595\": \"string\",\n \"key_596\": \"string\",\n \"key_597\": \"string\",\n \"key_598\": \"string\",\n \"key_599\": \"string\",\n \"key_600\": \"string\",\n \"key_601\": \"string\",\n \"key_602\": \"string\",\n \"key_603\": \"string\",\n \"key_604\": \"string\",\n \"key_605\": \"string\",\n \"key_606\": \"string\",\n \"key_607\": \"string\",\n \"key_608\": \"string\",\n \"key_609\": \"string\",\n \"key_610\": \"string\",\n \"key_611\": \"string\",\n \"key_612\": \"string\",\n \"key_613\": \"string\",\n \"key_614\": \"string\",\n \"key_615\": \"string\",\n \"key_616\": \"string\",\n \"key_617\": \"string\",\n \"key_618\": \"string\",\n \"key_619\": \"string\",\n \"key_620\": \"string\",\n \"key_621\": \"string\",\n \"key_622\": \"string\",\n \"key_623\": \"string\",\n \"key_624\": \"string\",\n \"key_625\": \"string\",\n \"key_626\": \"string\",\n \"key_627\": \"string\",\n \"key_628\": \"string\",\n \"key_629\": \"string\",\n \"key_630\": \"string\",\n \"key_631\": \"string\",\n \"key_632\": \"string\",\n \"key_633\": \"string\",\n \"key_634\": \"string\",\n \"key_635\": \"string\",\n \"key_636\": \"string\",\n \"key_637\": \"string\",\n \"key_638\": \"string\",\n \"key_639\": \"string\",\n \"key_640\": \"string\",\n \"key_641\": \"string\",\n \"key_642\": \"string\",\n \"key_643\": \"string\",\n \"key_644\": \"string\",\n \"key_645\": \"string\",\n \"key_646\": \"string\",\n \"key_647\": \"string\",\n \"key_648\": \"string\",\n \"key_649\": \"string\",\n \"key_650\": \"string\",\n \"key_651\": \"string\",\n \"key_652\": \"string\",\n \"key_653\": \"string\",\n \"key_654\": \"string\",\n \"key_655\": \"string\",\n \"key_656\": \"string\",\n \"key_657\": \"string\",\n \"key_658\": \"string\",\n \"key_659\": \"string\",\n \"key_660\": \"string\",\n \"key_661\": \"string\",\n \"key_662\": \"string\",\n \"key_663\": \"string\",\n \"key_664\": \"string\",\n \"key_665\": \"string\",\n \"key_666\": \"string\",\n \"key_667\": \"string\",\n \"key_668\": \"string\",\n \"key_669\": \"string\",\n \"key_670\": \"string\",\n \"key_671\": \"string\",\n \"key_672\": \"string\",\n \"key_673\": \"string\",\n \"key_674\": \"string\",\n \"key_675\": \"string\",\n \"key_676\": \"string\",\n \"key_677\": \"string\",\n \"key_678\": \"string\",\n \"key_679\": \"string\",\n \"key_680\": \"string\",\n \"key_681\": \"string\",\n \"key_682\": \"string\",\n \"key_683\": \"string\",\n \"key_684\": \"string\",\n \"key_685\": \"string\",\n \"key_686\": \"string\",\n \"key_687\": \"string\",\n \"key_688\": \"string\",\n \"key_689\": \"string\",\n \"key_690\": \"string\",\n \"key_691\": \"string\",\n \"key_692\": \"string\",\n \"key_693\": \"string\",\n \"key_694\": \"string\",\n \"key_695\": \"string\",\n \"key_696\": \"string\",\n \"key_697\": \"string\",\n \"key_698\": \"string\",\n \"key_699\": \"string\",\n \"key_700\": \"string\",\n \"key_701\": \"string\",\n \"key_702\": \"string\",\n \"key_703\": \"string\",\n \"key_704\": \"string\",\n \"key_705\": \"string\",\n \"key_706\": \"string\",\n \"key_707\": \"string\",\n \"key_708\": \"string\",\n \"key_709\": \"string\",\n \"key_710\": \"string\",\n \"key_711\": \"string\",\n \"key_712\": \"string\",\n \"key_713\": \"string\",\n \"key_714\": \"string\",\n \"key_715\": \"string\",\n \"key_716\": \"string\",\n \"key_717\": \"string\",\n \"key_718\": \"string\",\n \"key_719\": \"string\",\n \"key_720\": \"string\",\n \"key_721\": \"string\",\n \"key_722\": \"string\",\n \"key_723\": \"string\",\n \"key_724\": \"string\",\n \"key_725\": \"string\",\n \"key_726\": \"string\",\n \"key_727\": \"string\",\n \"key_728\": \"string\",\n \"key_729\": \"string\",\n \"key_730\": \"string\",\n \"key_731\": \"string\"\n },\n \"forwardedRequestParameters\": [\n \"login_hint\"\n ],\n \"claimsToPersist\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ]\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an Authentication Provider", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve an existing Authentication Provider by providing its ID.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_START\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Authentication Provider retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"clientId\": \"vJ0SCKchr4XjC0xHNE8DkH6Pmlg2lkCN\",\n \"clientSecret\": \"***********************************************************6-OjH\",\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"redirectUrl\": \"https://tenant.vii.mattr.global/v1/oauth/authentication/callback\",\n \"url\": \"http://WQEZeQLIREJbYu.sizjhRzBDG6UdHUgr0zWwadzmtcH+M6Lm2zX\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"staticRequestParameters\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\",\n \"key_4\": \"string\",\n \"key_5\": \"string\",\n \"key_6\": \"string\",\n \"key_7\": \"string\",\n \"key_8\": \"string\",\n \"key_9\": \"string\",\n \"key_10\": \"string\",\n \"key_11\": \"string\",\n \"key_12\": \"string\",\n \"key_13\": \"string\",\n \"key_14\": \"string\",\n \"key_15\": \"string\",\n \"key_16\": \"string\",\n \"key_17\": \"string\",\n \"key_18\": \"string\",\n \"key_19\": \"string\",\n \"key_20\": \"string\",\n \"key_21\": \"string\",\n \"key_22\": \"string\",\n \"key_23\": \"string\",\n \"key_24\": \"string\",\n \"key_25\": \"string\",\n \"key_26\": \"string\",\n \"key_27\": \"string\",\n \"key_28\": \"string\",\n \"key_29\": \"string\",\n \"key_30\": \"string\",\n \"key_31\": \"string\",\n \"key_32\": \"string\",\n \"key_33\": \"string\",\n \"key_34\": \"string\",\n \"key_35\": \"string\",\n \"key_36\": \"string\",\n \"key_37\": \"string\",\n \"key_38\": \"string\",\n \"key_39\": \"string\",\n \"key_40\": \"string\",\n \"key_41\": \"string\",\n \"key_42\": \"string\",\n \"key_43\": \"string\",\n \"key_44\": \"string\",\n \"key_45\": \"string\",\n \"key_46\": \"string\",\n \"key_47\": \"string\",\n \"key_48\": \"string\",\n \"key_49\": \"string\",\n \"key_50\": \"string\",\n \"key_51\": \"string\",\n \"key_52\": \"string\",\n \"key_53\": \"string\",\n \"key_54\": \"string\",\n \"key_55\": \"string\",\n \"key_56\": \"string\",\n \"key_57\": \"string\",\n \"key_58\": \"string\",\n \"key_59\": \"string\",\n \"key_60\": \"string\",\n \"key_61\": \"string\",\n \"key_62\": \"string\",\n \"key_63\": \"string\",\n \"key_64\": \"string\",\n \"key_65\": \"string\",\n \"key_66\": \"string\",\n \"key_67\": \"string\",\n \"key_68\": \"string\",\n \"key_69\": \"string\",\n \"key_70\": \"string\",\n \"key_71\": \"string\",\n \"key_72\": \"string\",\n \"key_73\": \"string\",\n \"key_74\": \"string\",\n \"key_75\": \"string\",\n \"key_76\": \"string\",\n \"key_77\": \"string\",\n \"key_78\": \"string\",\n \"key_79\": \"string\",\n \"key_80\": \"string\",\n \"key_81\": \"string\",\n \"key_82\": \"string\",\n \"key_83\": \"string\",\n \"key_84\": \"string\",\n \"key_85\": \"string\",\n \"key_86\": \"string\",\n \"key_87\": \"string\",\n \"key_88\": \"string\",\n \"key_89\": \"string\",\n \"key_90\": \"string\",\n \"key_91\": \"string\",\n \"key_92\": \"string\",\n \"key_93\": \"string\",\n \"key_94\": \"string\",\n \"key_95\": \"string\",\n \"key_96\": \"string\",\n \"key_97\": \"string\",\n \"key_98\": \"string\",\n \"key_99\": \"string\",\n \"key_100\": \"string\",\n \"key_101\": \"string\",\n \"key_102\": \"string\",\n \"key_103\": \"string\",\n \"key_104\": \"string\",\n \"key_105\": \"string\",\n \"key_106\": \"string\",\n \"key_107\": \"string\",\n \"key_108\": \"string\",\n \"key_109\": \"string\",\n \"key_110\": \"string\",\n \"key_111\": \"string\",\n \"key_112\": \"string\",\n \"key_113\": \"string\",\n \"key_114\": \"string\",\n \"key_115\": \"string\",\n \"key_116\": \"string\",\n \"key_117\": \"string\",\n \"key_118\": \"string\",\n \"key_119\": \"string\",\n \"key_120\": \"string\",\n \"key_121\": \"string\",\n \"key_122\": \"string\",\n \"key_123\": \"string\",\n \"key_124\": \"string\",\n \"key_125\": \"string\",\n \"key_126\": \"string\",\n \"key_127\": \"string\",\n \"key_128\": \"string\",\n \"key_129\": \"string\",\n \"key_130\": \"string\",\n \"key_131\": \"string\",\n \"key_132\": \"string\",\n \"key_133\": \"string\",\n \"key_134\": \"string\",\n \"key_135\": \"string\",\n \"key_136\": \"string\",\n \"key_137\": \"string\",\n \"key_138\": \"string\",\n \"key_139\": \"string\",\n \"key_140\": \"string\",\n \"key_141\": \"string\",\n \"key_142\": \"string\",\n \"key_143\": \"string\",\n \"key_144\": \"string\",\n \"key_145\": \"string\",\n \"key_146\": \"string\",\n \"key_147\": \"string\",\n \"key_148\": \"string\",\n \"key_149\": \"string\",\n \"key_150\": \"string\",\n \"key_151\": \"string\",\n \"key_152\": \"string\",\n \"key_153\": \"string\",\n \"key_154\": \"string\",\n \"key_155\": \"string\",\n \"key_156\": \"string\",\n \"key_157\": \"string\",\n \"key_158\": \"string\",\n \"key_159\": \"string\",\n \"key_160\": \"string\",\n \"key_161\": \"string\",\n \"key_162\": \"string\",\n \"key_163\": \"string\",\n \"key_164\": \"string\",\n \"key_165\": \"string\",\n \"key_166\": \"string\",\n \"key_167\": \"string\",\n \"key_168\": \"string\",\n \"key_169\": \"string\",\n \"key_170\": \"string\",\n \"key_171\": \"string\",\n \"key_172\": \"string\",\n \"key_173\": \"string\",\n \"key_174\": \"string\",\n \"key_175\": \"string\",\n \"key_176\": \"string\",\n \"key_177\": \"string\",\n \"key_178\": \"string\",\n \"key_179\": \"string\",\n \"key_180\": \"string\",\n \"key_181\": \"string\",\n \"key_182\": \"string\",\n \"key_183\": \"string\",\n \"key_184\": \"string\",\n \"key_185\": \"string\",\n \"key_186\": \"string\",\n \"key_187\": \"string\",\n \"key_188\": \"string\",\n \"key_189\": \"string\",\n \"key_190\": \"string\",\n \"key_191\": \"string\",\n \"key_192\": \"string\",\n \"key_193\": \"string\",\n \"key_194\": \"string\",\n \"key_195\": \"string\",\n \"key_196\": \"string\",\n \"key_197\": \"string\",\n \"key_198\": \"string\",\n \"key_199\": \"string\",\n \"key_200\": \"string\",\n \"key_201\": \"string\",\n \"key_202\": \"string\",\n \"key_203\": \"string\",\n \"key_204\": \"string\",\n \"key_205\": \"string\",\n \"key_206\": \"string\",\n \"key_207\": \"string\",\n \"key_208\": \"string\",\n \"key_209\": \"string\",\n \"key_210\": \"string\",\n \"key_211\": \"string\",\n \"key_212\": \"string\",\n \"key_213\": \"string\",\n \"key_214\": \"string\",\n \"key_215\": \"string\",\n \"key_216\": \"string\",\n \"key_217\": \"string\",\n \"key_218\": \"string\",\n \"key_219\": \"string\",\n \"key_220\": \"string\",\n \"key_221\": \"string\",\n \"key_222\": \"string\",\n \"key_223\": \"string\",\n \"key_224\": \"string\",\n \"key_225\": \"string\",\n \"key_226\": \"string\",\n \"key_227\": \"string\",\n \"key_228\": \"string\",\n \"key_229\": \"string\",\n \"key_230\": \"string\",\n \"key_231\": \"string\",\n \"key_232\": \"string\",\n \"key_233\": \"string\",\n \"key_234\": \"string\",\n \"key_235\": \"string\",\n \"key_236\": \"string\",\n \"key_237\": \"string\",\n \"key_238\": \"string\",\n \"key_239\": \"string\",\n \"key_240\": \"string\",\n \"key_241\": \"string\",\n \"key_242\": \"string\",\n \"key_243\": \"string\",\n \"key_244\": \"string\",\n \"key_245\": \"string\",\n \"key_246\": \"string\",\n \"key_247\": \"string\",\n \"key_248\": \"string\",\n \"key_249\": \"string\",\n \"key_250\": \"string\",\n \"key_251\": \"string\",\n \"key_252\": \"string\",\n \"key_253\": \"string\",\n \"key_254\": \"string\",\n \"key_255\": \"string\",\n \"key_256\": \"string\",\n \"key_257\": \"string\",\n \"key_258\": \"string\",\n \"key_259\": \"string\",\n \"key_260\": \"string\",\n \"key_261\": \"string\",\n \"key_262\": \"string\",\n \"key_263\": \"string\",\n \"key_264\": \"string\",\n \"key_265\": \"string\",\n \"key_266\": \"string\",\n \"key_267\": \"string\",\n \"key_268\": \"string\",\n \"key_269\": \"string\",\n \"key_270\": \"string\",\n \"key_271\": \"string\",\n \"key_272\": \"string\",\n \"key_273\": \"string\",\n \"key_274\": \"string\",\n \"key_275\": \"string\",\n \"key_276\": \"string\",\n \"key_277\": \"string\",\n \"key_278\": \"string\",\n \"key_279\": \"string\",\n \"key_280\": \"string\",\n \"key_281\": \"string\",\n \"key_282\": \"string\",\n \"key_283\": \"string\",\n \"key_284\": \"string\",\n \"key_285\": \"string\",\n \"key_286\": \"string\",\n \"key_287\": \"string\",\n \"key_288\": \"string\",\n \"key_289\": \"string\",\n \"key_290\": \"string\",\n \"key_291\": \"string\",\n \"key_292\": \"string\",\n \"key_293\": \"string\",\n \"key_294\": \"string\",\n \"key_295\": \"string\",\n \"key_296\": \"string\",\n \"key_297\": \"string\",\n \"key_298\": \"string\",\n \"key_299\": \"string\",\n \"key_300\": \"string\",\n \"key_301\": \"string\",\n \"key_302\": \"string\",\n \"key_303\": \"string\",\n \"key_304\": \"string\",\n \"key_305\": \"string\",\n \"key_306\": \"string\",\n \"key_307\": \"string\",\n \"key_308\": \"string\",\n \"key_309\": \"string\",\n \"key_310\": \"string\",\n \"key_311\": \"string\",\n \"key_312\": \"string\",\n \"key_313\": \"string\",\n \"key_314\": \"string\",\n \"key_315\": \"string\",\n \"key_316\": \"string\",\n \"key_317\": \"string\",\n \"key_318\": \"string\",\n \"key_319\": \"string\",\n \"key_320\": \"string\",\n \"key_321\": \"string\",\n \"key_322\": \"string\",\n \"key_323\": \"string\",\n \"key_324\": \"string\",\n \"key_325\": \"string\",\n \"key_326\": \"string\",\n \"key_327\": \"string\",\n \"key_328\": \"string\",\n \"key_329\": \"string\",\n \"key_330\": \"string\",\n \"key_331\": \"string\",\n \"key_332\": \"string\",\n \"key_333\": \"string\",\n \"key_334\": \"string\",\n \"key_335\": \"string\",\n \"key_336\": \"string\",\n \"key_337\": \"string\",\n \"key_338\": \"string\",\n \"key_339\": \"string\",\n \"key_340\": \"string\",\n \"key_341\": \"string\",\n \"key_342\": \"string\",\n \"key_343\": \"string\",\n \"key_344\": \"string\",\n \"key_345\": \"string\",\n \"key_346\": \"string\",\n \"key_347\": \"string\",\n \"key_348\": \"string\",\n \"key_349\": \"string\",\n \"key_350\": \"string\",\n \"key_351\": \"string\",\n \"key_352\": \"string\",\n \"key_353\": \"string\",\n \"key_354\": \"string\",\n \"key_355\": \"string\",\n \"key_356\": \"string\",\n \"key_357\": \"string\",\n \"key_358\": \"string\",\n \"key_359\": \"string\",\n \"key_360\": \"string\",\n \"key_361\": \"string\",\n \"key_362\": \"string\",\n \"key_363\": \"string\",\n \"key_364\": \"string\",\n \"key_365\": \"string\",\n \"key_366\": \"string\",\n \"key_367\": \"string\",\n \"key_368\": \"string\",\n \"key_369\": \"string\",\n \"key_370\": \"string\",\n \"key_371\": \"string\",\n \"key_372\": \"string\",\n \"key_373\": \"string\",\n \"key_374\": \"string\",\n \"key_375\": \"string\",\n \"key_376\": \"string\",\n \"key_377\": \"string\",\n \"key_378\": \"string\",\n \"key_379\": \"string\",\n \"key_380\": \"string\",\n \"key_381\": \"string\",\n \"key_382\": \"string\",\n \"key_383\": \"string\",\n \"key_384\": \"string\",\n \"key_385\": \"string\",\n \"key_386\": \"string\",\n \"key_387\": \"string\",\n \"key_388\": \"string\",\n \"key_389\": \"string\",\n \"key_390\": \"string\",\n \"key_391\": \"string\",\n \"key_392\": \"string\",\n \"key_393\": \"string\",\n \"key_394\": \"string\",\n \"key_395\": \"string\",\n \"key_396\": \"string\",\n \"key_397\": \"string\",\n \"key_398\": \"string\",\n \"key_399\": \"string\",\n \"key_400\": \"string\",\n \"key_401\": \"string\",\n \"key_402\": \"string\",\n \"key_403\": \"string\",\n \"key_404\": \"string\",\n \"key_405\": \"string\",\n \"key_406\": \"string\",\n \"key_407\": \"string\",\n \"key_408\": \"string\",\n \"key_409\": \"string\",\n \"key_410\": \"string\",\n \"key_411\": \"string\",\n \"key_412\": \"string\",\n \"key_413\": \"string\",\n \"key_414\": \"string\",\n \"key_415\": \"string\",\n \"key_416\": \"string\",\n \"key_417\": \"string\",\n \"key_418\": \"string\",\n \"key_419\": \"string\",\n \"key_420\": \"string\",\n \"key_421\": \"string\",\n \"key_422\": \"string\",\n \"key_423\": \"string\",\n \"key_424\": \"string\",\n \"key_425\": \"string\",\n \"key_426\": \"string\",\n \"key_427\": \"string\",\n \"key_428\": \"string\",\n \"key_429\": \"string\",\n \"key_430\": \"string\",\n \"key_431\": \"string\",\n \"key_432\": \"string\",\n \"key_433\": \"string\",\n \"key_434\": \"string\",\n \"key_435\": \"string\",\n \"key_436\": \"string\",\n \"key_437\": \"string\",\n \"key_438\": \"string\",\n \"key_439\": \"string\",\n \"key_440\": \"string\",\n \"key_441\": \"string\",\n \"key_442\": \"string\",\n \"key_443\": \"string\",\n \"key_444\": \"string\",\n \"key_445\": \"string\",\n \"key_446\": \"string\",\n \"key_447\": \"string\",\n \"key_448\": \"string\",\n \"key_449\": \"string\",\n \"key_450\": \"string\",\n \"key_451\": \"string\",\n \"key_452\": \"string\",\n \"key_453\": \"string\",\n \"key_454\": \"string\",\n \"key_455\": \"string\",\n \"key_456\": \"string\",\n \"key_457\": \"string\",\n \"key_458\": \"string\",\n \"key_459\": \"string\",\n \"key_460\": \"string\",\n \"key_461\": \"string\",\n \"key_462\": \"string\",\n \"key_463\": \"string\",\n \"key_464\": \"string\",\n \"key_465\": \"string\",\n \"key_466\": \"string\",\n \"key_467\": \"string\",\n \"key_468\": \"string\",\n \"key_469\": \"string\",\n \"key_470\": \"string\",\n \"key_471\": \"string\",\n \"key_472\": \"string\",\n \"key_473\": \"string\",\n \"key_474\": \"string\",\n \"key_475\": \"string\",\n \"key_476\": \"string\",\n \"key_477\": \"string\",\n \"key_478\": \"string\",\n \"key_479\": \"string\",\n \"key_480\": \"string\",\n \"key_481\": \"string\",\n \"key_482\": \"string\",\n \"key_483\": \"string\",\n \"key_484\": \"string\",\n \"key_485\": \"string\",\n \"key_486\": \"string\",\n \"key_487\": \"string\",\n \"key_488\": \"string\",\n \"key_489\": \"string\",\n \"key_490\": \"string\",\n \"key_491\": \"string\",\n \"key_492\": \"string\",\n \"key_493\": \"string\",\n \"key_494\": \"string\",\n \"key_495\": \"string\",\n \"key_496\": \"string\",\n \"key_497\": \"string\",\n \"key_498\": \"string\",\n \"key_499\": \"string\",\n \"key_500\": \"string\",\n \"key_501\": \"string\",\n \"key_502\": \"string\",\n \"key_503\": \"string\",\n \"key_504\": \"string\",\n \"key_505\": \"string\",\n \"key_506\": \"string\",\n \"key_507\": \"string\",\n \"key_508\": \"string\",\n \"key_509\": \"string\",\n \"key_510\": \"string\",\n \"key_511\": \"string\",\n \"key_512\": \"string\",\n \"key_513\": \"string\",\n \"key_514\": \"string\",\n \"key_515\": \"string\",\n \"key_516\": \"string\",\n \"key_517\": \"string\",\n \"key_518\": \"string\",\n \"key_519\": \"string\",\n \"key_520\": \"string\",\n \"key_521\": \"string\",\n \"key_522\": \"string\",\n \"key_523\": \"string\",\n \"key_524\": \"string\",\n \"key_525\": \"string\",\n \"key_526\": \"string\",\n \"key_527\": \"string\",\n \"key_528\": \"string\",\n \"key_529\": \"string\",\n \"key_530\": \"string\",\n \"key_531\": \"string\",\n \"key_532\": \"string\",\n \"key_533\": \"string\",\n \"key_534\": \"string\",\n \"key_535\": \"string\",\n \"key_536\": \"string\",\n \"key_537\": \"string\",\n \"key_538\": \"string\",\n \"key_539\": \"string\",\n \"key_540\": \"string\",\n \"key_541\": \"string\",\n \"key_542\": \"string\",\n \"key_543\": \"string\",\n \"key_544\": \"string\",\n \"key_545\": \"string\",\n \"key_546\": \"string\",\n \"key_547\": \"string\",\n \"key_548\": \"string\",\n \"key_549\": \"string\",\n \"key_550\": \"string\",\n \"key_551\": \"string\",\n \"key_552\": \"string\",\n \"key_553\": \"string\",\n \"key_554\": \"string\",\n \"key_555\": \"string\",\n \"key_556\": \"string\",\n \"key_557\": \"string\",\n \"key_558\": \"string\",\n \"key_559\": \"string\",\n \"key_560\": \"string\",\n \"key_561\": \"string\",\n \"key_562\": \"string\",\n \"key_563\": \"string\",\n \"key_564\": \"string\",\n \"key_565\": \"string\",\n \"key_566\": \"string\",\n \"key_567\": \"string\",\n \"key_568\": \"string\",\n \"key_569\": \"string\",\n \"key_570\": \"string\",\n \"key_571\": \"string\",\n \"key_572\": \"string\",\n \"key_573\": \"string\",\n \"key_574\": \"string\",\n \"key_575\": \"string\",\n \"key_576\": \"string\",\n \"key_577\": \"string\",\n \"key_578\": \"string\",\n \"key_579\": \"string\",\n \"key_580\": \"string\",\n \"key_581\": \"string\",\n \"key_582\": \"string\",\n \"key_583\": \"string\",\n \"key_584\": \"string\",\n \"key_585\": \"string\",\n \"key_586\": \"string\",\n \"key_587\": \"string\",\n \"key_588\": \"string\",\n \"key_589\": \"string\",\n \"key_590\": \"string\",\n \"key_591\": \"string\",\n \"key_592\": \"string\",\n \"key_593\": \"string\",\n \"key_594\": \"string\",\n \"key_595\": \"string\",\n \"key_596\": \"string\",\n \"key_597\": \"string\",\n \"key_598\": \"string\",\n \"key_599\": \"string\",\n \"key_600\": \"string\",\n \"key_601\": \"string\",\n \"key_602\": \"string\",\n \"key_603\": \"string\",\n \"key_604\": \"string\",\n \"key_605\": \"string\",\n \"key_606\": \"string\",\n \"key_607\": \"string\",\n \"key_608\": \"string\",\n \"key_609\": \"string\",\n \"key_610\": \"string\",\n \"key_611\": \"string\",\n \"key_612\": \"string\",\n \"key_613\": \"string\",\n \"key_614\": \"string\",\n \"key_615\": \"string\",\n \"key_616\": \"string\",\n \"key_617\": \"string\",\n \"key_618\": \"string\",\n \"key_619\": \"string\",\n \"key_620\": \"string\",\n \"key_621\": \"string\",\n \"key_622\": \"string\",\n \"key_623\": \"string\",\n \"key_624\": \"string\",\n \"key_625\": \"string\",\n \"key_626\": \"string\",\n \"key_627\": \"string\",\n \"key_628\": \"string\",\n \"key_629\": \"string\",\n \"key_630\": \"string\",\n \"key_631\": \"string\",\n \"key_632\": \"string\",\n \"key_633\": \"string\",\n \"key_634\": \"string\",\n \"key_635\": \"string\",\n \"key_636\": \"string\",\n \"key_637\": \"string\",\n \"key_638\": \"string\",\n \"key_639\": \"string\",\n \"key_640\": \"string\",\n \"key_641\": \"string\",\n \"key_642\": \"string\",\n \"key_643\": \"string\",\n \"key_644\": \"string\",\n \"key_645\": \"string\",\n \"key_646\": \"string\",\n \"key_647\": \"string\",\n \"key_648\": \"string\",\n \"key_649\": \"string\",\n \"key_650\": \"string\",\n \"key_651\": \"string\",\n \"key_652\": \"string\",\n \"key_653\": \"string\",\n \"key_654\": \"string\",\n \"key_655\": \"string\",\n \"key_656\": \"string\",\n \"key_657\": \"string\",\n \"key_658\": \"string\",\n \"key_659\": \"string\",\n \"key_660\": \"string\",\n \"key_661\": \"string\",\n \"key_662\": \"string\",\n \"key_663\": \"string\",\n \"key_664\": \"string\",\n \"key_665\": \"string\",\n \"key_666\": \"string\",\n \"key_667\": \"string\",\n \"key_668\": \"string\",\n \"key_669\": \"string\",\n \"key_670\": \"string\",\n \"key_671\": \"string\",\n \"key_672\": \"string\",\n \"key_673\": \"string\",\n \"key_674\": \"string\",\n \"key_675\": \"string\",\n \"key_676\": \"string\",\n \"key_677\": \"string\",\n \"key_678\": \"string\",\n \"key_679\": \"string\",\n \"key_680\": \"string\",\n \"key_681\": \"string\",\n \"key_682\": \"string\",\n \"key_683\": \"string\",\n \"key_684\": \"string\",\n \"key_685\": \"string\",\n \"key_686\": \"string\",\n \"key_687\": \"string\",\n \"key_688\": \"string\",\n \"key_689\": \"string\",\n \"key_690\": \"string\",\n \"key_691\": \"string\",\n \"key_692\": \"string\",\n \"key_693\": \"string\",\n \"key_694\": \"string\",\n \"key_695\": \"string\",\n \"key_696\": \"string\",\n \"key_697\": \"string\",\n \"key_698\": \"string\",\n \"key_699\": \"string\",\n \"key_700\": \"string\",\n \"key_701\": \"string\",\n \"key_702\": \"string\",\n \"key_703\": \"string\",\n \"key_704\": \"string\",\n \"key_705\": \"string\",\n \"key_706\": \"string\",\n \"key_707\": \"string\",\n \"key_708\": \"string\",\n \"key_709\": \"string\",\n \"key_710\": \"string\",\n \"key_711\": \"string\",\n \"key_712\": \"string\",\n \"key_713\": \"string\",\n \"key_714\": \"string\",\n \"key_715\": \"string\",\n \"key_716\": \"string\",\n \"key_717\": \"string\",\n \"key_718\": \"string\",\n \"key_719\": \"string\",\n \"key_720\": \"string\",\n \"key_721\": \"string\",\n \"key_722\": \"string\",\n \"key_723\": \"string\",\n \"key_724\": \"string\",\n \"key_725\": \"string\",\n \"key_726\": \"string\",\n \"key_727\": \"string\",\n \"key_728\": \"string\",\n \"key_729\": \"string\",\n \"key_730\": \"string\",\n \"key_731\": \"string\",\n \"key_732\": \"string\",\n \"key_733\": \"string\",\n \"key_734\": \"string\",\n \"key_735\": \"string\",\n \"key_736\": \"string\",\n \"key_737\": \"string\",\n \"key_738\": \"string\",\n \"key_739\": \"string\",\n \"key_740\": \"string\",\n \"key_741\": \"string\",\n \"key_742\": \"string\",\n \"key_743\": \"string\",\n \"key_744\": \"string\",\n \"key_745\": \"string\",\n \"key_746\": \"string\",\n \"key_747\": \"string\",\n \"key_748\": \"string\",\n \"key_749\": \"string\",\n \"key_750\": \"string\",\n \"key_751\": \"string\",\n \"key_752\": \"string\",\n \"key_753\": \"string\",\n \"key_754\": \"string\",\n \"key_755\": \"string\",\n \"key_756\": \"string\",\n \"key_757\": \"string\",\n \"key_758\": \"string\",\n \"key_759\": \"string\",\n \"key_760\": \"string\",\n \"key_761\": \"string\",\n \"key_762\": \"string\",\n \"key_763\": \"string\",\n \"key_764\": \"string\",\n \"key_765\": \"string\",\n \"key_766\": \"string\",\n \"key_767\": \"string\",\n \"key_768\": \"string\",\n \"key_769\": \"string\",\n \"key_770\": \"string\",\n \"key_771\": \"string\",\n \"key_772\": \"string\",\n \"key_773\": \"string\",\n \"key_774\": \"string\",\n \"key_775\": \"string\",\n \"key_776\": \"string\",\n \"key_777\": \"string\",\n \"key_778\": \"string\",\n \"key_779\": \"string\",\n \"key_780\": \"string\",\n \"key_781\": \"string\",\n \"key_782\": \"string\",\n \"key_783\": \"string\",\n \"key_784\": \"string\",\n \"key_785\": \"string\",\n \"key_786\": \"string\",\n \"key_787\": \"string\",\n \"key_788\": \"string\",\n \"key_789\": \"string\",\n \"key_790\": \"string\",\n \"key_791\": \"string\",\n \"key_792\": \"string\",\n \"key_793\": \"string\",\n \"key_794\": \"string\",\n \"key_795\": \"string\",\n \"key_796\": \"string\",\n \"key_797\": \"string\",\n \"key_798\": \"string\",\n \"key_799\": \"string\",\n \"key_800\": \"string\",\n \"key_801\": \"string\",\n \"key_802\": \"string\",\n \"key_803\": \"string\",\n \"key_804\": \"string\",\n \"key_805\": \"string\",\n \"key_806\": \"string\",\n \"key_807\": \"string\",\n \"key_808\": \"string\",\n \"key_809\": \"string\",\n \"key_810\": \"string\",\n \"key_811\": \"string\",\n \"key_812\": \"string\",\n \"key_813\": \"string\",\n \"key_814\": \"string\",\n \"key_815\": \"string\",\n \"key_816\": \"string\",\n \"key_817\": \"string\",\n \"key_818\": \"string\",\n \"key_819\": \"string\",\n \"key_820\": \"string\",\n \"key_821\": \"string\",\n \"key_822\": \"string\",\n \"key_823\": \"string\",\n \"key_824\": \"string\",\n \"key_825\": \"string\",\n \"key_826\": \"string\",\n \"key_827\": \"string\",\n \"key_828\": \"string\",\n \"key_829\": \"string\",\n \"key_830\": \"string\",\n \"key_831\": \"string\",\n \"key_832\": \"string\",\n \"key_833\": \"string\",\n \"key_834\": \"string\",\n \"key_835\": \"string\",\n \"key_836\": \"string\",\n \"key_837\": \"string\",\n \"key_838\": \"string\",\n \"key_839\": \"string\",\n \"key_840\": \"string\",\n \"key_841\": \"string\",\n \"key_842\": \"string\",\n \"key_843\": \"string\",\n \"key_844\": \"string\",\n \"key_845\": \"string\",\n \"key_846\": \"string\",\n \"key_847\": \"string\",\n \"key_848\": \"string\",\n \"key_849\": \"string\",\n \"key_850\": \"string\",\n \"key_851\": \"string\",\n \"key_852\": \"string\",\n \"key_853\": \"string\",\n \"key_854\": \"string\",\n \"key_855\": \"string\",\n \"key_856\": \"string\",\n \"key_857\": \"string\",\n \"key_858\": \"string\",\n \"key_859\": \"string\",\n \"key_860\": \"string\",\n \"key_861\": \"string\",\n \"key_862\": \"string\",\n \"key_863\": \"string\",\n \"key_864\": \"string\",\n \"key_865\": \"string\",\n \"key_866\": \"string\",\n \"key_867\": \"string\",\n \"key_868\": \"string\",\n \"key_869\": \"string\",\n \"key_870\": \"string\",\n \"key_871\": \"string\",\n \"key_872\": \"string\",\n \"key_873\": \"string\",\n \"key_874\": \"string\",\n \"key_875\": \"string\",\n \"key_876\": \"string\",\n \"key_877\": \"string\",\n \"key_878\": \"string\",\n \"key_879\": \"string\",\n \"key_880\": \"string\",\n \"key_881\": \"string\",\n \"key_882\": \"string\",\n \"key_883\": \"string\",\n \"key_884\": \"string\",\n \"key_885\": \"string\",\n \"key_886\": \"string\",\n \"key_887\": \"string\",\n \"key_888\": \"string\",\n \"key_889\": \"string\",\n \"key_890\": \"string\",\n \"key_891\": \"string\",\n \"key_892\": \"string\",\n \"key_893\": \"string\",\n \"key_894\": \"string\",\n \"key_895\": \"string\",\n \"key_896\": \"string\",\n \"key_897\": \"string\",\n \"key_898\": \"string\",\n \"key_899\": \"string\",\n \"key_900\": \"string\",\n \"key_901\": \"string\",\n \"key_902\": \"string\",\n \"key_903\": \"string\",\n \"key_904\": \"string\",\n \"key_905\": \"string\",\n \"key_906\": \"string\",\n \"key_907\": \"string\",\n \"key_908\": \"string\",\n \"key_909\": \"string\",\n \"key_910\": \"string\",\n \"key_911\": \"string\",\n \"key_912\": \"string\",\n \"key_913\": \"string\",\n \"key_914\": \"string\",\n \"key_915\": \"string\",\n \"key_916\": \"string\",\n \"key_917\": \"string\",\n \"key_918\": \"string\",\n \"key_919\": \"string\",\n \"key_920\": \"string\",\n \"key_921\": \"string\",\n \"key_922\": \"string\",\n \"key_923\": \"string\",\n \"key_924\": \"string\",\n \"key_925\": \"string\",\n \"key_926\": \"string\",\n \"key_927\": \"string\",\n \"key_928\": \"string\",\n \"key_929\": \"string\",\n \"key_930\": \"string\",\n \"key_931\": \"string\",\n \"key_932\": \"string\",\n \"key_933\": \"string\",\n \"key_934\": \"string\",\n \"key_935\": \"string\",\n \"key_936\": \"string\",\n \"key_937\": \"string\",\n \"key_938\": \"string\",\n \"key_939\": \"string\",\n \"key_940\": \"string\",\n \"key_941\": \"string\",\n \"key_942\": \"string\",\n \"key_943\": \"string\",\n \"key_944\": \"string\",\n \"key_945\": \"string\",\n \"key_946\": \"string\",\n \"key_947\": \"string\",\n \"key_948\": \"string\",\n \"key_949\": \"string\",\n \"key_950\": \"string\",\n \"key_951\": \"string\",\n \"key_952\": \"string\",\n \"key_953\": \"string\",\n \"key_954\": \"string\",\n \"key_955\": \"string\",\n \"key_956\": \"string\",\n \"key_957\": \"string\",\n \"key_958\": \"string\",\n \"key_959\": \"string\",\n \"key_960\": \"string\",\n \"key_961\": \"string\",\n \"key_962\": \"string\",\n \"key_963\": \"string\",\n \"key_964\": \"string\",\n \"key_965\": \"string\",\n \"key_966\": \"string\",\n \"key_967\": \"string\",\n \"key_968\": \"string\",\n \"key_969\": \"string\",\n \"key_970\": \"string\",\n \"key_971\": \"string\",\n \"key_972\": \"string\",\n \"key_973\": \"string\",\n \"key_974\": \"string\",\n \"key_975\": \"string\",\n \"key_976\": \"string\",\n \"key_977\": \"string\",\n \"key_978\": \"string\",\n \"key_979\": \"string\",\n \"key_980\": \"string\",\n \"key_981\": \"string\",\n \"key_982\": \"string\",\n \"key_983\": \"string\",\n \"key_984\": \"string\"\n },\n \"forwardedRequestParameters\": [\n \"login_hint\"\n ],\n \"claimsToPersist\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an Authentication Provider", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"value\": \"", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/authentication-providers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "authentication-providers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Authentication Provider ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Authentication providers for OID4VCI workflows." + }, + { + "name": "Interaction Hook", + "item": [ + { + "name": "Configure Interaction Hook", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"interactionHook\": {\n \"url\": \"https://example-university.com/callback\",\n \"claims\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ],\n \"sessionTimeoutInSec\": 1200,\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Configure the Interaction Hook for the OpenID4VCI protocol on your tenant.\nMany credential issuance journeys require the issuer to perform custom interactions with the user. This could be gathering more information, performing additional authentication steps (E.g, 2FA, MFA or biometric checks) or communicating the terms of service. To facilitate this requirement, you can configure MATTR VII to invoke an interaction hook which will redirect the user to a custom component during the credential issuance journey. This redirect happens **after** the user is authenticated with your configured identity provider but **before** the credential is issued to the user. Upon successful completion of the interaction hook, your custom component will redirect the user back to their digital wallet to complete the credential issuance flow. Your interaction hook component can be either a web or native application.  We recommend using a web interface because it's more compatible with most scenarios.\n> You can only configure one interaction hook on your MATTR VII tenant. If you require several custom interactions as part of the credential issuance workflow, they should all be linked into a single interaction hook component.\n\n### **Analytic events**\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_START\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_FAIL" + }, + "response": [ + { + "name": "Interaction Hook configured", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"interactionHook\": {\n \"url\": \"https://example-university.com/callback\",\n \"claims\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ],\n \"sessionTimeoutInSec\": 1200,\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"interactionHook\": {\n \"url\": \"https://example-university.com/callback\",\n \"claims\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ],\n \"sessionTimeoutInSec\": 1200,\n \"disabled\": false,\n \"secret\": \"dGtUrijBOT6UUJ8JO4kAFyGfhahDlVVeIk/sPbWTa7c=\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"interactionHook\": {\n \"url\": \"https://example-university.com/callback\",\n \"claims\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ],\n \"sessionTimeoutInSec\": 1200,\n \"disabled\": false\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve Interaction Hook", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/openid/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves the Interaction Hook configuration from your tenant.\n\n### **Analytic events**\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Interaction Hook configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/openid/configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "configuration" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"interactionHook\": {\n \"url\": \"https://example-university.com/callback\",\n \"claims\": [\n \"first_name\",\n \"last_name\",\n \"email\"\n ],\n \"sessionTimeoutInSec\": 1200,\n \"disabled\": false,\n \"secret\": \"dGtUrijBOT6UUJ8JO4kAFyGfhahDlVVeIk/sPbWTa7c=\"\n }\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Interaction hooks for OID4VCI workflows." + }, + { + "name": "Claims Source", + "item": [ + { + "name": "Configure a claims source", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Claims source accepting a x-api-key header\",\n \"url\": \"https://example.com/api/data\",\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"requestParameters\": {\n \"account_type\": {\n \"mapFrom\": \"claims.accountType\",\n \"defaultValue\": \"account.student\"\n },\n \"account_id\": {\n \"mapFrom\": \"claims.accountId\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Configures a new claims source for your tenant. When issuing a new credential, MATTR VII will make either a GET or a POST request to the claims source using the configured request parameters and fetch available data. This fetched data can then be included in the issued credential.\n\n### **Analytic event**\n* CLAIM_SOURCE_CREATE_START\n* CLAIM_SOURCE_CREATE_SUCCESS\n* CLAIM_SOURCE_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Claims source configured", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Claims source accepting a x-api-key header\",\n \"url\": \"https://example.com/api/data\",\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"requestParameters\": {\n \"account_type\": {\n \"mapFrom\": \"claims.accountType\",\n \"defaultValue\": \"account.student\"\n },\n \"account_id\": {\n \"mapFrom\": \"claims.accountId\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"Claims source accepting a x-api-key header\",\n \"url\": \"https://example.com/api/data\",\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"****************************************61m1J\"\n },\n \"requestParameters\": {\n \"account_type\": {\n \"mapFrom\": \"claims.accountType\",\n \"defaultValue\": \"account.student\"\n },\n \"account_id\": {\n \"mapFrom\": \"claims.accountId\"\n }\n }\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Claims source accepting a x-api-key header\",\n \"url\": \"https://example.com/api/data\",\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"requestParameters\": {\n \"account_type\": {\n \"mapFrom\": \"claims.accountType\",\n \"defaultValue\": \"account.student\"\n },\n \"account_id\": {\n \"mapFrom\": \"claims.accountId\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"body\",\n \"msg\": \"Invalid value\",\n \"param\": \"url\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all claims sources", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned entries, default 100" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the range of entries" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all claims sources configured on your tenant.\n\n### **Analytic event**\n* CLAIM_SOURCE_RETRIEVE_LIST_START\n* CLAIM_SOURCE_RETRIEVE_LIST_SUCCESS\n* CLAIM_SOURCE_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Claims sources retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"id\": \"57fa09e2-82f3-4d3d-9eca-d0253e84a4e6\",\n \"requestMethod\": \"POST\"\n },\n {\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"id\": \"57fa09e2-82f3-4d3d-9eca-d0253e84a4e6\",\n \"requestMethod\": \"GET\"\n }\n ]\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"query\",\n \"msg\": \"Invalid value\",\n \"param\": \"cursor\",\n \"value\": \"abc\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a claims source", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing claims source by providing its `claimSourceID`.\n\n### **Analytic event**\n* CLAIM_SOURCE_RETRIEVE_START\n* CLAIM_SOURCE_RETRIEVE_SUCCESS\n* CLAIM_SOURCE_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Claims source retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"id\": \"57fa09e2-82f3-4d3d-9eca-d0253e84a4e6\",\n \"requestMethod\": \"GET\"\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Invalid value\",\n \"param\": \"claimSourceId\",\n \"value\": \"abc\"\n }\n ]\n}" + }, + { + "name": "Claims source not found", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Resource Not Found\",\n \"param\": \"claimSourceId\",\n \"value\": \"a368cfb4-9537-4439-acc6-ce3cf2287eb7\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a claims source", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"requestMethod\": \"GET\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing claim source by providing its `claimSourceID`.\n\n### **Analytic event**\n* CLAIM_SOURCE_UPDATE_START\n* CLAIM_SOURCE_UPDATE_SUCCESS\n* CLAIM_SOURCE_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "Claims source updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"requestMethod\": \"GET\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"id\": \"57fa09e2-82f3-4d3d-9eca-d0253e84a4e6\",\n \"requestMethod\": \"GET\"\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"requestMethod\": \"GET\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"body\",\n \"msg\": \"Invalid value\",\n \"param\": \"url\"\n }\n ]\n}" + }, + { + "name": "Claims source not found", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"authorization\": {\n \"type\": \"api-key\",\n \"value\": \"6hrFDATxrG9w14QY9wwnmVhLE0Wg6LIvwOwUaxz761m1J\"\n },\n \"name\": \"My claims from example.com\",\n \"requestParameters\": {\n \"mapFrom\": \"claims.accountType\"\n },\n \"url\": \"https://example.com\",\n \"requestMethod\": \"GET\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Resource Not Found\",\n \"param\": \"claimSourceId\",\n \"value\": \"a368cfb4-9537-4439-acc6-ce3cf2287eb7\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a claims source", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing claims source by providing its `claimSourceID`.\n\n### **Analytic event**\n* CLAIM_SOURCE_DELETE_START\n* CLAIM_SOURCE_DELETE_SUCCESS\n* CLAIM_SOURCE_DELETE_FAIL\n" + }, + "response": [ + { + "name": "Claims source deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Invalid value\",\n \"param\": \"claimSourceId\",\n \"value\": \"abc\"\n }\n ]\n}" + }, + { + "name": "Claims source not found", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/claim-sources/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "claim-sources", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Claims source ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Resource Not Found\",\n \"param\": \"claimSourceId\",\n \"value\": \"a368cfb4-9537-4439-acc6-ce3cf2287eb7\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Claim sources for OID4VCI workflows." + }, + { + "name": "Credential configurations", + "item": [ + { + "name": "mDocs", + "item": [ + { + "name": "Create an mDocs configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new mDocs 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.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_CREATE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" + }, + "response": [ + { + "name": "mDocs configuration created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2024.7782541689708,\n \"months\": 1,\n \"weeks\": 5329.180084571776,\n \"days\": 1346.6113100953137,\n \"hours\": 9863.185517329943,\n \"minutes\": 2623.207831738392,\n \"seconds\": 3593.9069390833\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"data:image/png;base64,{image-data}\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true,\n \"claimSourceId\": \"2670642e-2767-2e20-adb6-478e612cb17a\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all mDocs configurations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + }, + { + "key": "type", + "value": "AlumniCredential", + "description": "Optional credential type to filter on" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all mDocs configurations from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "mDocs configurations retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 7240.62516706655,\n \"months\": 1,\n \"weeks\": 8662.943439477589,\n \"days\": 2422.539412552673,\n \"hours\": 1085.6766180067034,\n \"minutes\": 4739.589032415332,\n \"seconds\": 2234.6957694288385\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"data:image/png;base64,{image-data}\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true,\n \"claimSourceId\": \"bb0ea028-0c4e-4f98-dd30-fcaf4857d2bd\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n }\n },\n {\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 6162.718458522582,\n \"months\": 1,\n \"weeks\": 2807.260233465909,\n \"days\": 1403.2939624631101,\n \"hours\": 1661.3122299117977,\n \"minutes\": 2667.329519547006,\n \"seconds\": 9437.325031834016\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"data:image/png;base64,{image-data}\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true,\n \"claimSourceId\": \"ce250701-093e-920f-12c5-5a9a8e46d07b\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an mDocs configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing mDocs configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "mDocs configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2024.7782541689708,\n \"months\": 1,\n \"weeks\": 5329.180084571776,\n \"days\": 1346.6113100953137,\n \"hours\": 9863.185517329943,\n \"minutes\": 2623.207831738392,\n \"seconds\": 3593.9069390833\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"data:image/png;base64,{image-data}\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true,\n \"claimSourceId\": \"2670642e-2767-2e20-adb6-478e612cb17a\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an mDocs configuration", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing mDocs configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "mDocs configuration updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2024.7782541689708,\n \"months\": 1,\n \"weeks\": 5329.180084571776,\n \"days\": 1346.6113100953137,\n \"hours\": 9863.185517329943,\n \"minutes\": 2623.207831738392,\n \"seconds\": 3593.9069390833\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"data:image/png;base64,{image-data}\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true,\n \"claimSourceId\": \"2670642e-2767-2e20-adb6-478e612cb17a\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"type\": \"DriverLicense\",\n \"expiresIn\": {\n \"years\": 2397.818683484101,\n \"months\": 1,\n \"weeks\": 5508.836534983563,\n \"days\": 8026.057527859068,\n \"hours\": 4147.9994203226925,\n \"minutes\": 9577.199958424175,\n \"seconds\": 7693.9312390647465\n },\n \"claimMappings\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true,\n \"type\": \"string\"\n },\n \"birth_date\": {\n \"mapFrom\": \"claims.date_of_birth\",\n \"required\": true,\n \"type\": \"dateTime\"\n }\n }\n },\n \"claimSourceId\": \"f3cc71ea-6f96-1d65-8283-0de5453227b0\",\n \"validFrom\": {\n \"mapFrom\": \"string\"\n },\n \"validUntil\": {\n \"mapFrom\": \"string\"\n },\n \"branding\": {\n \"name\": \"Credential name\",\n \"description\": \"Credential Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": \"data:image/png;base64,{image-data}\",\n \"issuerLogo\": \"https://example-path-to-image-data.com\",\n \"issuerIcon\": \"data:image/svg+xml;base64,{image-data}\"\n },\n \"includeStatus\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an mDocs configuration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing mDocs configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_DELETE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" + }, + "response": [ + { + "name": "mDocs configuration deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDocs configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing mDocs credentials configuration." + }, + { + "name": "CWT credentials", + "item": [ + { + "name": "Create a CWT credential configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new CWT 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.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" + }, + "response": [ + { + "name": "CWT credential configuration created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": \"CourseCredential\",\n \"claimSourceId\": \"56a8b3c6-4f2a-ccf4-844e-5fbdb1983464\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all CWT credential configurations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + }, + { + "key": "type", + "value": "AlumniCredential", + "description": "The optional credential type to filter on" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all CWT credential configurations from your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "CWT credential configurations retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": \"CourseCredential\",\n \"claimSourceId\": \"67337845-7453-230d-d190-230f2f3726a4\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n },\n {\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": \"CourseCredential\",\n \"claimSourceId\": \"275ca525-f6a6-4a1f-9056-7e9ac7126d13\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a CWT credential configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a CWT credential configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "CWT credential configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": \"CourseCredential\",\n \"claimSourceId\": \"56a8b3c6-4f2a-ccf4-844e-5fbdb1983464\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a CWT credential configuration", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing CWT credential configuration by providing its ID.\n \n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "CWT credential configuration updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": \"CourseCredential\",\n \"claimSourceId\": \"56a8b3c6-4f2a-ccf4-844e-5fbdb1983464\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": \"CourseCredential\",\n \"revocable\": true,\n \"claimSourceId\": \"b3998534-12d7-ea21-fcf8-e035e4ce8651\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a CWT credential configuration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing CWT credential configuration by providing its ID.\n \n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" + }, + "response": [ + { + "name": "CWT credential configuration deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the CWT credential configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for creating CWT credentials configuration." + }, + { + "name": "Semantic CWT credentials", + "item": [ + { + "name": "Create a Semantic CWT credentials configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new Semantic CWT credentials 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.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Credential configuration created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"eb36891c-650e-9790-d0f5-909b9eb50541\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Semantic CWT credentials configurations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + }, + { + "key": "type", + "value": "AlumniCredential", + "description": "The optional credential type to filter on" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all Compact Semantic Credential configurations from your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Semantic CWT credentials configurations retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"04b6349c-7c63-bbae-91eb-79ddfa36f12c\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n },\n {\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"9ae0eeca-f72f-c76b-8342-663538bcd414\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Semantic CWT credentials configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a Semantic CWT credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Semantic CWT credentials configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"eb36891c-650e-9790-d0f5-909b9eb50541\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a Semantic CWT credentials configuration", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing Semantic CWT credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "Semantic CWT credentials configuration updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"eb36891c-650e-9790-d0f5-909b9eb50541\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"1a1fbcd6-bc6e-3ea2-4464-686be15d2e67\",\n \"expiresIn\": {\n \"years\": 1,\n \"months\": 12,\n \"weeks\": 52,\n \"days\": 365,\n \"hours\": 24,\n \"minutes\": 1440,\n \"seconds\": 3600\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a Semantic CWT credentials configuration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing Semantic CWT credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" + }, + "response": [ + { + "name": "Semantic CWT credentials configuration deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for creating Semantic CWT credentials configuration." + }, + { + "name": "JSON credentials", + "item": [ + { + "name": "Create a JSON credentials configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"e6607711-ae8e-1464-5e4e-f7414c876d54\",\n \"expiresIn\": {\n \"years\": 1299.576171922603,\n \"months\": 3,\n \"weeks\": 7371.465860924104,\n \"days\": 7401.584932742265,\n \"hours\": 1239.51526374668,\n \"minutes\": 6589.908265826693,\n \"seconds\": 4630.609745898204\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new JSON credentials 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.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" + }, + "response": [ + { + "name": "JSON credentials configuration created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"2ae9aa8e-7b3c-92a7-f384-c55d1fe3c175\",\n \"expiresIn\": {\n \"years\": 9112.595289313176,\n \"months\": 3,\n \"weeks\": 2616.446941289723,\n \"days\": 3910.517620082663,\n \"hours\": 574.3669971702725,\n \"minutes\": 5758.632382126591,\n \"seconds\": 1066.9118450325966\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"claimSourceId\": \"67c65cc7-ff18-eff9-a4f0-257f9dd1818e\",\n \"expiresIn\": {\n \"years\": 3422.950451621363,\n \"months\": 3,\n \"weeks\": 7364.307445063807,\n \"days\": 218.2774402376042,\n \"hours\": 4883.340140504071,\n \"minutes\": 8574.773851885815,\n \"seconds\": 4364.975157469855\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"2ae9aa8e-7b3c-92a7-f384-c55d1fe3c175\",\n \"expiresIn\": {\n \"years\": 9112.595289313176,\n \"months\": 3,\n \"weeks\": 2616.446941289723,\n \"days\": 3910.517620082663,\n \"hours\": 574.3669971702725,\n \"minutes\": 5758.632382126591,\n \"seconds\": 1066.9118450325966\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all JSON credentials configurations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + }, + { + "key": "type", + "value": "AlumniCredential", + "description": "The optional credential type to filter on" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all JSON credential configurations on your tenant.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "JSON credentials configurations retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"claimSourceId\": \"6c9e08e5-b7f4-1e3d-9680-cc75ddb6ffb9\",\n \"expiresIn\": {\n \"years\": 7304.344305823547,\n \"months\": 3,\n \"weeks\": 5996.71727250477,\n \"days\": 6602.468128707912,\n \"hours\": 4056.692584940924,\n \"minutes\": 5113.62407944242,\n \"seconds\": 2111.9731881440584\n }\n },\n {\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"claimSourceId\": \"a18eab2d-8ecc-1a20-10b8-3c7f0baecf3f\",\n \"expiresIn\": {\n \"years\": 8844.061874978255,\n \"months\": 3,\n \"weeks\": 7252.183685059627,\n \"days\": 6168.4342947175155,\n \"hours\": 3414.059056815728,\n \"minutes\": 2214.302784249651,\n \"seconds\": 4717.744008513009\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h&type=AlumniCredential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + }, + { + "key": "type", + "value": "AlumniCredential" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a JSON credentials configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve a JSON credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "JSON credentials configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"claimSourceId\": \"67c65cc7-ff18-eff9-a4f0-257f9dd1818e\",\n \"expiresIn\": {\n \"years\": 3422.950451621363,\n \"months\": 3,\n \"weeks\": 7364.307445063807,\n \"days\": 218.2774402376042,\n \"hours\": 4883.340140504071,\n \"minutes\": 8574.773851885815,\n \"seconds\": 4364.975157469855\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a JSON credentials configuration", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"e6607711-ae8e-1464-5e4e-f7414c876d54\",\n \"expiresIn\": {\n \"years\": 1299.576171922603,\n \"months\": 3,\n \"weeks\": 7371.465860924104,\n \"days\": 7401.584932742265,\n \"hours\": 1239.51526374668,\n \"minutes\": 6589.908265826693,\n \"seconds\": 4630.609745898204\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing JSON credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "JSON credentials configuration updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"2ae9aa8e-7b3c-92a7-f384-c55d1fe3c175\",\n \"expiresIn\": {\n \"years\": 9112.595289313176,\n \"months\": 3,\n \"weeks\": 2616.446941289723,\n \"days\": 3910.517620082663,\n \"hours\": 574.3669971702725,\n \"minutes\": 5758.632382126591,\n \"seconds\": 1066.9118450325966\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"claimSourceId\": \"67c65cc7-ff18-eff9-a4f0-257f9dd1818e\",\n \"expiresIn\": {\n \"years\": 3422.950451621363,\n \"months\": 3,\n \"weeks\": 7364.307445063807,\n \"days\": 218.2774402376042,\n \"hours\": 4883.340140504071,\n \"minutes\": 8574.773851885815,\n \"seconds\": 4364.975157469855\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"2ae9aa8e-7b3c-92a7-f384-c55d1fe3c175\",\n \"expiresIn\": {\n \"years\": 9112.595289313176,\n \"months\": 3,\n \"weeks\": 2616.446941289723,\n \"days\": 3910.517620082663,\n \"hours\": 574.3669971702725,\n \"minutes\": 5758.632382126591,\n \"seconds\": 1066.9118450325966\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Course credential\",\n \"type\": \"CourseCredential\",\n \"issuer\": {\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"description\": \"This credential shows that the person has attended a course.\",\n \"additionalTypes\": [\n \"AlumniCredential\",\n \"EducationCredential\"\n ],\n \"contexts\": [\n \"https://optionalschema.example/\"\n ],\n \"proofType\": \"Ed25519Signature2018\",\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"claimMappings\": {\n \"firstName\": {\n \"mapFrom\": \"claims.given_name\",\n \"required\": true\n },\n \"address\": {\n \"mapFrom\": \"claims.address.formatted\"\n },\n \"picture\": {\n \"mapFrom\": \"claims.picture\",\n \"defaultValue\": \"http://example.edu/img/placeholder.png\"\n },\n \"badge\": {\n \"defaultValue\": \"http://example.edu/img/badge.png\"\n },\n \"providerSubjectId\": {\n \"mapFrom\": \"authenticationProvider.subjectId\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"2ae9aa8e-7b3c-92a7-f384-c55d1fe3c175\",\n \"expiresIn\": {\n \"years\": 9112.595289313176,\n \"months\": 3,\n \"weeks\": 2616.446941289723,\n \"days\": 3910.517620082663,\n \"hours\": 574.3669971702725,\n \"minutes\": 5758.632382126591,\n \"seconds\": 1066.9118450325966\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a JSON credentials configuration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing JSON credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" + }, + "response": [ + { + "name": "JSON credentials configuration deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "The credential configuration is not found", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) JSON credentials configuration unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Resource Not Found\",\n \"param\": \"id\",\n \"value\": \"638c5634-fb06-403a-bb00-ddb867ea9063\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing JSON credentials configuration." + } + ] + }, + { + "name": "Credential issuance", + "item": [ + { + "name": "Request authorization for access to resources", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string&scope=string&state=string&code_challenge_method=S256&code_challenge=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "authorize" + ], + "query": [ + { + "key": "response_type", + "value": "code", + "description": "(Required) The response type, which must be 'code'." + }, + { + "key": "client_id", + "value": "string", + "description": "(Required) The client identifier." + }, + { + "key": "redirect_uri", + "value": "string", + "description": "(Required) The URI to which the authorization server will redirect the user-agent with the authorization code." + }, + { + "key": "scope", + "value": "string", + "description": "(Required) The scope of the access request." + }, + { + "key": "state", + "value": "string", + "description": "An opaque value used by the client to maintain state between the request and callback." + }, + { + "key": "code_challenge_method", + "value": "S256", + "description": "(Required) The method used to derive the code_challenge, which must be 'S256'." + }, + { + "key": "code_challenge", + "value": "string", + "description": "(Required) A high entropy random challenge generated by the client." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "This endpoint is used to request authorization from the user for access to the requested resources. After the user approves the request, an authorization code is returned to the client.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-authorization-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-authorization-endpoint)\nSee [https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1](https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1)\n\n### **Analytic events**\n* OPENID_AUTHORIZE_START\n* OPENID_AUTHORIZE_SUCCESS\n* OPENID_AUTHORIZE_FAIL\n" + }, + "response": [ + { + "name": "Redirection to client application with authorization code", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string&scope=string&state=string&code_challenge_method=S256&code_challenge=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "authorize" + ], + "query": [ + { + "key": "response_type", + "value": "code" + }, + { + "key": "client_id", + "value": "string" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "scope", + "value": "string" + }, + { + "key": "state", + "value": "string" + }, + { + "key": "code_challenge_method", + "value": "S256" + }, + { + "key": "code_challenge", + "value": "string" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Found", + "code": 302, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Location", + "value": "string", + "description": "URL to redirect to with the authorization code" + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string&scope=string&state=string&code_challenge_method=S256&code_challenge=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "authorize" + ], + "query": [ + { + "key": "response_type", + "value": "code" + }, + { + "key": "client_id", + "value": "string" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "scope", + "value": "string" + }, + { + "key": "state", + "value": "string" + }, + { + "key": "code_challenge_method", + "value": "S256" + }, + { + "key": "code_challenge", + "value": "string" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Unauthorized. The client is not recognized by authorization server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "text/plain" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string&scope=string&state=string&code_challenge_method=S256&code_challenge=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "authorize" + ], + "query": [ + { + "key": "response_type", + "value": "code" + }, + { + "key": "client_id", + "value": "string" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "scope", + "value": "string" + }, + { + "key": "state", + "value": "string" + }, + { + "key": "code_challenge_method", + "value": "S256" + }, + { + "key": "code_challenge", + "value": "string" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "Unauthorized" + }, + { + "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string&scope=string&state=string&code_challenge_method=S256&code_challenge=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "authorize" + ], + "query": [ + { + "key": "response_type", + "value": "code" + }, + { + "key": "client_id", + "value": "string" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "scope", + "value": "string" + }, + { + "key": "state", + "value": "string" + }, + { + "key": "code_challenge_method", + "value": "S256" + }, + { + "key": "code_challenge", + "value": "string" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/oauth/authorize?response_type=code&client_id=string&redirect_uri=string&scope=string&state=string&code_challenge_method=S256&code_challenge=string", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "authorize" + ], + "query": [ + { + "key": "response_type", + "value": "code" + }, + { + "key": "client_id", + "value": "string" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "scope", + "value": "string" + }, + { + "key": "state", + "value": "string" + }, + { + "key": "code_challenge_method", + "value": "S256" + }, + { + "key": "code_challenge", + "value": "string" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Exchange authorization code for access token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_id", + "value": "string" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "code", + "value": "string" + }, + { + "key": "code_verifier", + "value": "string" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v1/oauth/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "This endpoint is used to exchange an authorization code or a pre-authorized code for an access token, which is later used to request a credential.\n\n- In an Authorization Code flow the authorization code is obtained from the authorization endpoint after the user has successfully authenticated. \n- In a Pre-authorized Code flow the pre-authorized code is obtained from the offer URI.\n\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-token-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-token-endpoint) for more information.\n\n### **Analytic events**\n* OPENID_TOKEN_START\n* OPENID_TOKEN_SUCCESS\n* OPENID_TOKEN_FAIL\n" + }, + "response": [ + { + "name": "Access token successfully returned.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_id", + "value": "string" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "code", + "value": "string" + }, + { + "key": "code_verifier", + "value": "string" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v1/oauth/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"access_token\": \"string\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 5789,\n \"scope\": \"string\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_id", + "value": "string" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "code", + "value": "string" + }, + { + "key": "code_verifier", + "value": "string" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v1/oauth/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Unauthorized. The client is not recognized by authorization server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "text/plain" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_id", + "value": "string" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "code", + "value": "string" + }, + { + "key": "code_verifier", + "value": "string" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v1/oauth/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "Unauthorized" + }, + { + "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_id", + "value": "string" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "code", + "value": "string" + }, + { + "key": "code_verifier", + "value": "string" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v1/oauth/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Internal Server Error. An unexpected error occurred.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_id", + "value": "string" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "redirect_uri", + "value": "string" + }, + { + "key": "code", + "value": "string" + }, + { + "key": "code_verifier", + "value": "string" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v1/oauth/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "oauth", + "token" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "Issue a verifiable credential", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"format\": \"ldp_vc\",\n \"credential_definition\": {\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\"\n ]\n },\n \"proof\": {\n \"proof_type\": \"jwt\",\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/credential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "credential" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Issues a verifiable credential to a subject as part of the OpenID4VCI protocol.\n\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-endpoint)\n\n### **Analytic events**\n* OPENID_CREDENTIAL_START\n* OPENID_CREDENTIAL_SUCCESS\n* OPENID_CREDENTIAL_FAIL" + }, + "response": [ + { + "name": "Credential issued", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"format\": \"ldp_vc\",\n \"credential_definition\": {\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\"\n ]\n },\n \"proof\": {\n \"proof_type\": \"jwt\",\n \"jwt\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/credential", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "credential" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"credential\": {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://www.w3.org/2018/credentials/examples/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n },\n \"format\": \"ldp_vc\"\n}" + } + ] + }, + { + "name": "Create an Authorization Code credential offer", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentials\": [\n \"707e920a-f342-443b-ae24-6946b7b5033e\"\n ],\n \"request_parameters\": {\n \"login_hint\": \"user@example.com\",\n \"prompt\": \"login\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/offers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns an OpenID4VCI credential offer URI.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1)\n\n### **Analytic events**\n* OPENID_OFFER_CREATE_START\n* OPENID_OFFER_CREATE_SUCCESS\n* OPENID_OFFER_CREATE_FAIL" + }, + "response": [ + { + "name": "Credential offer URI created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentials\": [\n \"707e920a-f342-443b-ae24-6946b7b5033e\"\n ],\n \"request_parameters\": {\n \"login_hint\": \"user@example.com\",\n \"prompt\": \"login\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/offers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"uri\": \"openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fmyissuer.example.com%22%2C%22credentials%22%3A%5B%22707e920a-f342-443b-ae24-6946b7b5033e%22%5D%2C%22request_parameters%22%3A%7B%22login_hint%22%3A%22user%40example.com%22%2C%22prompt%22%3A%22login%22%7D%7D\"\n}" + } + ] + }, + { + "name": "Retrieve OpenID4VCI issuer metadata", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/.well-known/openid-credential-issuer", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ".well-known", + "openid-credential-issuer" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns OpenID4VCI issuer metadata. This is the standard OpenID4VCI Well Known endpoint for your tenant.\n\nThis endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party wishing to discover the OpenID4VCI capabilities." + }, + "response": [ + { + "name": "OpenID4VCI credential issuer metadata retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/.well-known/openid-credential-issuer", + "host": [ + "{{baseUrl}}" + ], + "path": [ + ".well-known", + "openid-credential-issuer" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"issuer\": \"http://xnvXqUeDtEwOxVglfZ.thNVGG.GFCYeVQE.w-yO2lCt,7\",\n \"authorization_endpoint\": \"https://SbqOhUrGiMIJmvMnhFplKt.gmswOXieiSWUWhWF5fua,D-xD63j4rd2-GBbm.GAYh7JXTAwMewoLum.SybKWu6K.FPS2kH-G+sZK\",\n \"token_endpoint\": \"https://AqyimamXFKxqVQjbWhKYQplAvxE.dypq1gPMYLU5RznxhxXAJcBXxBNhml\",\n \"scopes_supported\": [\n \"ldp_vc:ExampleCredential\"\n ],\n \"response_types_supported\": [\n \"code\"\n ],\n \"response_modes_supported\": [\n \"query\"\n ],\n \"grant_types_supported\": [\n \"authorization_code\"\n ],\n \"code_challenge_methods_supported\": [\n \"S256\"\n ],\n \"credential_issuer\": \"http://WCvtxiiNUKsOeJPOxikgCEdbmiOtkXj.glpkAqlmK\",\n \"credential_endpoint\": \"http://IGoVOlXlLqDuxuRGgticcup.cuhNtO,EvY+L2Lzz3HoZd,GJQtSLQ60avHELk09mhx,SPzYhu2U8rmnB2YzAbtpmT\",\n \"credentials_supported\": [\n {\n \"format\": \"string\",\n \"id\": \"string\",\n \"scope\": \"string\",\n \"@context\": [\n \"string\",\n \"string\"\n ],\n \"type\": [\n \"string\",\n \"string\"\n ],\n \"credentialSubject\": {},\n \"cryptographic_binding_methods_supported\": \"string\",\n \"cryptographic_suites_supported\": \"string\"\n },\n {\n \"format\": \"string\",\n \"id\": \"string\",\n \"scope\": \"string\",\n \"@context\": [\n \"string\",\n \"string\"\n ],\n \"type\": [\n \"string\",\n \"string\"\n ],\n \"credentialSubject\": {},\n \"cryptographic_binding_methods_supported\": \"string\",\n \"cryptographic_suites_supported\": \"string\"\n }\n ],\n \"mdoc_iacas_uri\": \"http://cmwOtxMMtEwzuwzvcMrxue.frJEFRJhhCWt0GDIPvO0NA-MIlsmQ9JQF5qqIxhxPK9PLwZmQ0\"\n}" + } + ] + }, + { + "name": "Create a Pre-Authorized Code credential offer", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentials\": [\n \"707e920a-f342-443b-ae24-6946b7b5033e\"\n ],\n \"userId\": \"string\",\n \"transactionCodeConfiguration\": {\n \"inputMode\": \"numeric\",\n \"description\": \"Please enter the one-time code that was sent to you via email.\"\n },\n \"claims\": {\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"claimsToPersist\": [\n \"email\"\n ],\n \"expiresIn\": {\n \"minutes\": 5,\n \"seconds\": 4089.7750792306642\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/offers/pre-authorized", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers", + "pre-authorized" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Generate a new [OpenID4VCI Pre-Authorized Code](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-4.1) credential offer.\n\n> The Pre-authorized Code flow is only supported for the mDocs credential format.\n\n### **Analytic events**\n* OPENID_PRE_AUTHORIZED_OFFER_CREATE_START\n* OPENID_PRE_AUTHORIZED_OFFER_CREATE_SUCCESS\n* OPENID_PRE_AUTHORIZED_OFFER_CREATE_FAIL" + }, + "response": [ + { + "name": "Credential offer created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"credentials\": [\n \"707e920a-f342-443b-ae24-6946b7b5033e\"\n ],\n \"userId\": \"string\",\n \"transactionCodeConfiguration\": {\n \"inputMode\": \"numeric\",\n \"description\": \"Please enter the one-time code that was sent to you via email.\"\n },\n \"claims\": {\n \"givenName\": \"John\",\n \"familyName\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"claimsToPersist\": [\n \"email\"\n ],\n \"expiresIn\": {\n \"minutes\": 5,\n \"seconds\": 8992.106474628485\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/openid/offers/pre-authorized", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers", + "pre-authorized" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"uri\": \"openid-credential-offer://?credential_offer=%7B%22credential_issuer%22%3A%22https%3A%2F%2Fexample.com%22%2C%22credentials%22%3A%5B%222edaf985-fcc2-4448-9c8e-a04c6c7351c2%22%5D%2C%22grants%22%3A%7B%22urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Apre-authorized_code%22%3A%7B%22pre-authorized_code%22%3A%22stukD6lg9c9tQ3jUCa32wVi1HI%2BQIVsFK%2FQPvC2CHRs%3D%22%2C%22tx_code%22%3A%7B%22length%22%3A6%2C%22input_mode%22%3A%22numeric%22%2C%22description%22%3A%22Please%20provide%20the%20one-time%20code%20that%20was%20sent%20via%20e-mail%22%7D%7D%7D%7D\",\n \"userId\": \"string\",\n \"expiresAt\": 7371.84004428729,\n \"transactionCode\": \"string\"\n}" + } + ] + }, + { + "name": "Delete a Pre-authorized Code credential offer", + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/openid/offers/pre-authorized/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers", + "pre-authorized", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) Pre-authorized credential offer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Delete an [OpenID4VCI Pre-authorized Code](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-4.1) credential offer.\n\n### **Analytic events**\n* OPENID_PRE_AUTHORIZED_OFFER_DELETE_START\n* OPENID_PRE_AUTHORIZED_OFFER_DELETE_SUCCESS\n* OPENID_PRE_AUTHORIZED_OFFER_DELETE_FAIL" + }, + "response": [ + { + "name": "Credential offer deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/openid/offers/pre-authorized/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers", + "pre-authorized", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) Pre-authorized credential offer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/openid/offers/pre-authorized/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers", + "pre-authorized", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) Pre-authorized credential offer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/openid/offers/pre-authorized/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "openid", + "offers", + "pre-authorized", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) Pre-authorized credential offer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for issuing credentials as part of an OID4VCI workflow." + }, + { + "name": "Users", + "item": [ + { + "name": "Search users", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"given_name\": \"Jamie\",\n \"address\": {\n \"street_name\": \"Queen Street\"\n }\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n },\n \"limit\": 100,\n \"cursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/search", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "search" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of users from the tenant that match all the provided search criteria (all criteria are optional).\n\n### **Analytic events**\n* USER_SEARCH_START\n* USER_SEARCH_SUCCESS\n* USER_SEARCH_FAIL" + }, + "response": [ + { + "name": "Users retrieved", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"given_name\": \"Jamie\",\n \"address\": {\n \"street_name\": \"Queen Street\"\n }\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n },\n \"limit\": 100,\n \"cursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/search", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "search" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n },\n {\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"given_name\": \"Jamie\",\n \"address\": {\n \"street_name\": \"Queen Street\"\n }\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n },\n \"limit\": 100,\n \"cursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/search", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + "search" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Create a User", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Create a user.\n\n* USER_CREATE_START\n* USER_CREATE_SUCCESS\n* USER_CREATE_FAIL" + }, + "response": [ + { + "name": "User created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all users", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all users on your tenant.\n\n### **Analytic events**\n* USER_RETRIEVE_LIST_START\n* USER_RETRIEVE_LIST_SUCCESS\n* USER_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Users retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n },\n {\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a user", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve an existing user by providing its ID.\n* USER_RETRIEVE_START\n* USER_RETRIEVE_SUCCESS\n* USER_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "User retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a User", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing user by providing its ID.\n\n* USER_UPDATE_START\n* USER_UPDATE_SUCCESS\n* USER_UPDATE_FAIL" + }, + "response": [ + { + "name": "User updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"0c3fad74-a8df-4a2d-8e75-f2d356b413ba\",\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"url\": \"https://example-university.au.auth0.com\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"claims\": {\n \"givenName\": \"Patrick John\",\n \"familyName\": \"Smith\",\n \"dob\": \"1990-06-01\"\n },\n \"authenticationProvider\": {\n \"providerId\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"subjectId\": \"example-university-oauth2|123456789\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a user", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a user and removes any persisted data related to them by providing the user ID.\n\n> Any credentials issued to the user remain valid even after the user is deleted.\n\n### **Analytic events**\n* USER_DELETE_START\n* USER_DELETE_SUCCESS\n* USER_DELETE_FAIL" + }, + "response": [ + { + "name": "User deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "8241400f-de3b-42c5-ad7c-8a380039e796", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all user credentials data", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:userId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":userId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "userId", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns metadata for all the credentials issued to the provided `userId`.\n\n### **Analytic events**\n* USER_CREDENTIAL_RETRIEVE_LIST_START\n* USER_CREDENTIAL_RETRIEVE_LIST_SUCCESS\n* USER_CREDENTIAL_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "User credentials retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:userId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":userId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "userId", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"552b35fe-a3ed-4c33-8c3c-64810c712323\",\n \"type\": \"org.iso.18013.5.1.mDL\",\n \"profile\": \"mobile\",\n \"sessionId\": \"4da5bce7-39d0-482e-8972-c674c688e01a\",\n \"credentialConfigurationId\": \"3948c40e-6e19-4ffc-933c-91f643f24264\",\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"crv\": \"P-256\",\n \"x\": \"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo\"\n },\n \"namespaces\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"digestID\": 0,\n \"digest\": \"8GWbUyIRA2xATs5ILEa0fVZF1QQt4JL5gG2aCtVsazU\"\n },\n \"family_name\": {\n \"digestID\": 1,\n \"digest\": \"R4jk/m0wX9KhENp7DVPr9AM7Hz+CJoEJNKJRQo92FCI\"\n }\n }\n },\n \"msoHash\": \"OsPO++ARsvvJYswmuzN8E3rxN+jAkbWbxhqVIOfM1Go\",\n \"issuedDate\": \"2025-06-28T12:34:56.000Z\",\n \"validFrom\": \"2025-06-30T12:00:00.000Z\",\n \"validUntil\": \"2025-07-30T12:00:00.000Z\",\n \"offerId\": \"b0877ef9-deaf-4c88-8765-2b5aad2913d9\",\n \"status\": \"valid\"\n },\n {\n \"id\": \"552b35fe-a3ed-4c33-8c3c-64810c712323\",\n \"type\": \"org.iso.18013.5.1.mDL\",\n \"profile\": \"mobile\",\n \"sessionId\": \"4da5bce7-39d0-482e-8972-c674c688e01a\",\n \"credentialConfigurationId\": \"3948c40e-6e19-4ffc-933c-91f643f24264\",\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"crv\": \"P-256\",\n \"x\": \"11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo\"\n },\n \"namespaces\": {\n \"org.iso.18013.5.1\": {\n \"given_name\": {\n \"digestID\": 0,\n \"digest\": \"8GWbUyIRA2xATs5ILEa0fVZF1QQt4JL5gG2aCtVsazU\"\n },\n \"family_name\": {\n \"digestID\": 1,\n \"digest\": \"R4jk/m0wX9KhENp7DVPr9AM7Hz+CJoEJNKJRQo92FCI\"\n }\n }\n },\n \"msoHash\": \"OsPO++ARsvvJYswmuzN8E3rxN+jAkbWbxhqVIOfM1Go\",\n \"issuedDate\": \"2025-06-28T12:34:56.000Z\",\n \"validFrom\": \"2025-06-30T12:00:00.000Z\",\n \"validUntil\": \"2025-07-30T12:00:00.000Z\",\n \"offerId\": \"b0877ef9-deaf-4c88-8765-2b5aad2913d9\",\n \"status\": \"valid\"\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v1/users/:userId/credentials?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v1", + "users", + ":userId", + "credentials" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "userId", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) User ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing users as part of OID4VCI workflows." + } + ] + }, + { + "name": "Direct credential issuance", + "item": [ + { + "name": "CWT credentials", + "item": [ + { + "name": "CWT credentials PDF templates", + "item": [ + { + "name": "Create a PDF template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance-direct/cwt/pdf-templates) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "PDF template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all PDF templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all CWT credentials PDF templates available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "PDF templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"0ecdcb57-ef2b-4aa1-be34-695c2d9d9486\",\n \"data\": [\n {\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n },\n {\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a PDF template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Update an existing CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance-direct/cwt/pdf-templates) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "PDF template updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a PDF template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing CWT credentials PDF template using its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "PDF template retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a PDF template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Delete an existing PDF template by providing its ID\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "PDF template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing CWT credentials PDF templates." + }, + { + "name": "CWT credentials Apple Pass templates", + "item": [ + { + "name": "Create an Apple Pass template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates an Apple Pass template based on the provided `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n> The Apple Pass template uses the official Apple Pass bundle structure.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Apple Pass templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all Apple Pass template available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Apple Pass templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\",\n \"data\": [\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n },\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an Apple Pass template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing Apple Pass template by providing its ID and a `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an Apple Pass template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an Apple Pass template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing CWT credentials Apple Pass templates." + }, + { + "name": "CWT credentials Google Pass templates", + "item": [ + { + "name": "Create a Google Pass template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a Google Pass template based on the provided `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Google Pass template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Google Pass templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all Google Pass templates available on your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Google Pass templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\",\n \"data\": [\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"apple\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n },\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a Google Pass template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates a existing Google Pass template by providing its ID and a `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "Google Pass template updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Google Pass template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Google Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Google Pass templated retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a Google Pass template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing Google Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Google Pass template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing CWT credentials Google Pass templates." + }, + { + "name": "Format a CWT credential as a QR code", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "image/png" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...\",\n \"width\": 250\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/qrcode", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "qrcode" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a QR code representation of a CWT credential from a provided encoded string representation of that credential.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_QRCODE_CREATE_START\n* CREDENTIAL_COMPACT_QRCODE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_QRCODE_CREATE_FAIL" + }, + "response": [ + { + "name": "QR code generated", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "image/png" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...\",\n \"width\": 250\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/qrcode", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "qrcode" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "image/png" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...\",\n \"width\": 250\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/qrcode", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "qrcode" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"1\",\n \"msg\": \"must be a string\",\n \"param\": \"payload\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a CWT credential as a PDF", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/pdf" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a PDF representation of a provided CWT credential based on an existing PDF template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_CREATE_START\n* CREDENTIAL_COMPACT_PDF_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_CREATE_FAIL" + }, + "response": [ + { + "name": "PDF created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/pdf" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/pdf" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a CWT credential as an Apple Pass", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/vnd.apple.pkpass" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns an Apple Pass representation of a provided CWT credential based on an existing Apple Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_CREATE_FAIL" + }, + "response": [ + { + "name": "Apple Pass created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/vnd.apple.pkpass" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.apple.pkpass" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "apple" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a CWT credential as a Google Pass", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_FAIL" + }, + "response": [ + { + "name": "Google Pass created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"redirectTo\": \"https://pay.google.com/gp/v/save/{jwt}\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "digital-pass", + "google" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Sign a CWT credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"iss\": \"did:web:organization.com\",\n \"nbf\": 1645743759,\n \"exp\": 1646743759,\n \"iat\": 1645743759,\n \"aud\": \"string\",\n \"sub\": \"string\",\n \"type\": \"string\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a signed CWT credential generated from a provided valid payload.\n\nThe payload can include any number of custom claims, as CWT credentials do not comply with any specific standard or specification.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SIGN_START\n* CREDENTIAL_COMPACT_SIGN_SUCCESS\n* CREDENTIAL_COMPACT_SIGN_FAIL" + }, + "response": [ + { + "name": "CWT credential signed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"iss\": \"did:web:organization.com\",\n \"nbf\": 1645743759,\n \"exp\": 1646743759,\n \"iat\": 1645743759,\n \"aud\": \"string\",\n \"sub\": \"string\",\n \"type\": \"string\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"encoded\": \"CSC:/1/2KCE3IQEJB5DCMSLN5KWKZABE2QFQRVDAF4CIZDJMQ5HOZLCHIYDGOJUFUYTENJNGIZTOLJVGIWTCMJQFZXGO4TPNMXGS33ENZQW2ZLEJJXWQ3QH3BAFB3LISHKGQ2KBJ6Q35NXZFD6LGZ2YIAYHZAKCF7NKTIUZUTZQ3PWDBALAWVRG5XL2H4P4WFK25X3Y5X5RTN7NOZUST67KLCEFS3EPXQU5KM7VUGOPXJLQ6K5U676PMQNWRZCZ\",\n \"decoded\": {\n \"iss\": \"did:web:organization.com\",\n \"nbf\": 1645743759,\n \"exp\": 1646743759,\n \"iat\": 1645743759,\n \"jti\": \"6tVMmKodQNaLywW6NGA2aA\",\n \"type\": \"CredentialType\",\n \"property1\": \"...\",\n \"property2\": \"...\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"iss\": \"did:web:organization.com\",\n \"nbf\": 1645743759,\n \"exp\": 1646743759,\n \"iat\": 1645743759,\n \"aud\": \"string\",\n \"sub\": \"string\",\n \"type\": \"string\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for issuing CWT credentials." + }, + { + "name": "Semantic CWT credentials", + "item": [ + { + "name": "Semantic CWT credentials PDF templates", + "item": [ + { + "name": "Create a PDF template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a Semantic CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance-direct/cwt/pdf-templates) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "PDF template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all PDF templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all Semantic CWT credential PDF templates available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "PDF templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"0ecdcb57-ef2b-4aa1-be34-695c2d9d9486\",\n \"data\": [\n {\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n },\n {\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a PDF template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/zip" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Update an existing CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance-direct/cwt/pdf-templates) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "PDF template updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "string" + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a PDF template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Semantic CWT credential PDF template using its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "PDF template retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"name\": \"Certificate of participation\",\n \"fileName\": \"certificate_of_participation\",\n \"fonts\": [\n {\n \"name\": \"PublicSans-Regular\",\n \"fileName\": \"fonts/PublicSans-Regular.ttf\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"familyName\",\n \"value\": \"{{payload.sub_claims.familyName}}\",\n \"isRequired\": true,\n \"alternativeText\": \"{{payload.sub_claims.familyName}}\",\n \"fontName\": \"PublicSans-Regular\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a PDF template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Delete an existing PDF template by providing its ID\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "PDF template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) PDF Template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Semantic CWT credentials PDF templates." + }, + { + "name": "Semantic CWT credentials Apple Pass templates", + "item": [ + { + "name": "Create an Apple Pass template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates an Apple Pass template based on the provided `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n> The Apple Pass template uses the official Apple Pass bundle structure.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Apple Pass templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all Apple Pass template available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Apple Pass templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\",\n \"data\": [\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n },\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an Apple Pass template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing Apple Pass template by providing its ID and a `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/apple-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Apple digital pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "fileName", + "value": "certificate_of_participation.pkpass", + "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", + "type": "text" + }, + { + "key": "teamIdentifier", + "value": "GH5P43ABC", + "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", + "type": "text" + }, + { + "key": "passTypeIdentifier", + "value": "pass.myproject.participation.pk", + "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", + "type": "text" + }, + { + "key": "wwdr", + "value": "string", + "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", + "type": "text" + }, + { + "key": "signerCert", + "value": "string", + "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", + "type": "text" + }, + { + "key": "signerKey", + "value": "string", + "description": "(Required) The encrypted key of the Apple pass signer certificate.", + "type": "text" + }, + { + "key": "signerKeyPassphrase", + "value": "string", + "description": "(Required) Passphrase for the encrypted key.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an Apple Pass template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"fileName\": \"certificate_of_participation.pkpass\",\n \"teamIdentifier\": \"GH5P43ABC\",\n \"passTypeIdentifier\": \"pass.myproject.participation.pk\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an Apple Pass template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Apple Pass template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Apple Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Semantic CWT credentials Apple Pass templates." + }, + { + "name": "Semantic CWT credentials Google Pass templates", + "item": [ + { + "name": "Create a Google Pass template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a Google Pass template based on the provided `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Google Pass template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Google Pass templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a list of all Google Pass templates available on your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Google Pass templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h\",\n \"data\": [\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"apple\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n },\n {\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a Google Pass template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates a existing Google Pass template by providing its ID and a `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance-direct/cwt/google-templates) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "Google Pass template updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "value": "Certificate of participation", + "description": "(Required) Insert a name to identify this Google Pass template.", + "type": "text" + }, + { + "key": "template", + "description": "(Required) Includes your template files.", + "type": "file", + "src": [] + }, + { + "key": "issuerId", + "value": "3388000000012346000", + "description": "(Required) Google Wallet Pass signer issuer ID.", + "type": "text" + }, + { + "key": "serviceAccountClientEmail", + "value": "app-user@myproject.iam.gserviceaccount.com", + "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", + "type": "text" + }, + { + "key": "serviceAccountPrivateKey", + "value": "string", + "description": "(Required) Private key PEM of the Google Cloud Platform service account.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Google Pass template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Google Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Google Pass templated retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"passType\": \"google\",\n \"name\": \"Certificate of participation\",\n \"metadata\": {\n \"issuerId\": \"3388000000012346000\",\n \"serviceAccountClientEmail\": \"app-user@myproject.iam.gserviceaccount.com\",\n \"payPassId\": \"3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a Google Pass template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Delete a Google Pay Pass template by ID\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Google Pass template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Google Pass template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Semantic CWT credentials Google Pass templates." + }, + { + "name": "Sign a Semantic CWT credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"iss\": \"did:web:organization.com\",\n \"vc\": {\n \"credentialSubject\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"type\": \"AlumniCredential\",\n \"@context\": \"https://www.w3.org/2018/credentials/examples/v1\"\n },\n \"nbf\": 1645743759,\n \"exp\": 1645743759,\n \"iat\": 1645743759,\n \"aud\": \"...\",\n \"sub\": \"...\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a signed Semantic CWT credential generated from a provided valid payload.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_SIGN_START\n* CREDENTIAL_COMPACT_SEMANTIC_SIGN_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_SIGN_FAIL" + }, + "response": [ + { + "name": "Semantic CWT credential signed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"iss\": \"did:web:organization.com\",\n \"vc\": {\n \"credentialSubject\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"type\": \"AlumniCredential\",\n \"@context\": \"https://www.w3.org/2018/credentials/examples/v1\"\n },\n \"nbf\": 1645743759,\n \"exp\": 1645743759,\n \"iat\": 1645743759,\n \"aud\": \"...\",\n \"sub\": \"...\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"encoded\": \"CSS:/1/BASE_32_ENCODED_PAYLOAD\",\n \"decoded\": {\n \"iss\": \"did:web:example.com\",\n \"nbf\": 1645743759,\n \"jti\": \"...\",\n \"vc\": {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://www.w3.org/2018/credentials/examples/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"credentialSubject\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n },\n \"exp\": 1645743759,\n \"iat\": 1645743759,\n \"aud\": \"...\",\n \"sub\": \"...\",\n \"status\": {\n \"url\": \"...\",\n \"index\": 123\n }\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"iss\": \"did:web:organization.com\",\n \"vc\": {\n \"credentialSubject\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"type\": \"AlumniCredential\",\n \"@context\": \"https://www.w3.org/2018/credentials/examples/v1\"\n },\n \"nbf\": 1645743759,\n \"exp\": 1645743759,\n \"iat\": 1645743759,\n \"aud\": \"...\",\n \"sub\": \"...\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a Semantic CWT credential as a QR code", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "image/png" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...\",\n \"width\": 250\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/qrcode", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "qrcode" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a QR code representation of a Semantic CWT credential from a provided encoded string representation of that credential.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_FAIL" + }, + "response": [ + { + "name": "QR code generated", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "image/png" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...\",\n \"width\": 250\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/qrcode", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "qrcode" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "image/png" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": \"CSS:/1/2KCE3IQEJB5DCMSMGRKXI3IBE2QFSANKVACBUYQYB2HQKGTCDAHI6BQ2MIMA5DYBPAUWI2L...\",\n \"width\": 250\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/qrcode", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "qrcode" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"value\": \"1\",\n \"msg\": \"must be a string\",\n \"param\": \"payload\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a CWT credential as a PDF", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/pdf" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a PDF representation of a provided CWT credential based on an existing PDF template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_FAIL" + }, + "response": [ + { + "name": "PDF created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/pdf" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/pdf" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"4eea7654-d4c5-4eba-bd7a-5ca334d54725\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "pdf" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a Semantic CWT credential as an Apple Pass", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/vnd.apple.pkpass" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns an Apple Pass representation of a provided Semantic CWT credential based on an existing Apple Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_FAIL" + }, + "response": [ + { + "name": "Apple Pass created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/vnd.apple.pkpass" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/vnd.apple.pkpass" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "apple" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Format a Semantic CWT credential as a Google Pass", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_FAIL" + }, + "response": [ + { + "name": "Google Pass created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"redirectTo\": \"https://pay.google.com/gp/v/save/{jwt}\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"templateId\": \"3812166c-ac9f-4e4e-96dd-c1336b5be378\",\n \"payload\": \"{payload}\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "digital-pass", + "google" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for issuing Semantic CWT credentials." + }, + { + "name": "JSON credentials", + "item": [ + { + "name": "Sign a JSON credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"type\": [\n \"EducationalOccupationalCredential\",\n \"AlumniCredential\"\n ],\n \"issuer\": {\n \"id\": \"did:issuer:abcdb1f712ebc6f1c276e12ec21\",\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"name\": \"Course credential\",\n \"description\": \"This credential shows that the person has attended the mention course and attained the relevant awards.\",\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"expirationDate\": \"2024-02-01T08:12:38.156Z\",\n \"issuanceDate\": \"2023-02-01T08:12:38.156Z\"\n },\n \"proofType\": \"Ed25519Signature2018\",\n \"tag\": \"identifier123\",\n \"persist\": false,\n \"revocable\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a signed JSON credential generated from a provided valid payload.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_SIGN_START\n* CREDENTIAL_WEB_SEMANTIC_SIGN_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_SIGN_FAIL" + }, + "response": [ + { + "name": "JSON Credential signed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"type\": [\n \"EducationalOccupationalCredential\",\n \"AlumniCredential\"\n ],\n \"issuer\": {\n \"id\": \"did:issuer:abcdb1f712ebc6f1c276e12ec21\",\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"name\": \"Course credential\",\n \"description\": \"This credential shows that the person has attended the mention course and attained the relevant awards.\",\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"expirationDate\": \"2024-02-01T08:12:38.156Z\",\n \"issuanceDate\": \"2023-02-01T08:12:38.156Z\"\n },\n \"proofType\": \"Ed25519Signature2018\",\n \"tag\": \"identifier123\",\n \"persist\": false,\n \"revocable\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"873277c0-a162-11ea-8a1d-a111119347e6\",\n \"credential\": {\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://mattr.global/contexts/vc-extensions/v2\",\n \"https://w3id.org/vc-revocation-list-2020/v1\",\n \"https://optionalschema.example/\"\n ],\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n },\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"tag\": \"identifier123\",\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"type\": [\n \"EducationalOccupationalCredential\",\n \"AlumniCredential\"\n ],\n \"issuer\": {\n \"id\": \"did:issuer:abcdb1f712ebc6f1c276e12ec21\",\n \"name\": \"ABC University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"name\": \"Course credential\",\n \"description\": \"This credential shows that the person has attended the mention course and attained the relevant awards.\",\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"expirationDate\": \"2024-02-01T08:12:38.156Z\",\n \"issuanceDate\": \"2023-02-01T08:12:38.156Z\"\n },\n \"proofType\": \"Ed25519Signature2018\",\n \"tag\": \"identifier123\",\n \"persist\": false,\n \"revocable\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/sign", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "sign" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for issuing JSON credentials." + } + ] + } + ] + }, + { + "name": "Credential management", + "item": [ + { + "name": "mDocs management", + "item": [ + { + "name": "Document Signers", + "item": [ + { + "name": "Create a Document Signer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"020a3e27-9ec3-c6f4-2c54-ea9d4765b793\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new Document Signer that can be used to sign new mDocs.\n- Only available in implementations using unmanaged (external) IACAs.\n- A maximum of five Document Signers can be created per tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_START\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_CREATE_FAIL" + }, + "response": [ + { + "name": "Document Signer created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"020a3e27-9ec3-c6f4-2c54-ea9d4765b793\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"555815d4-4bcc-f18b-663c-62e73dfc1ae9\",\n \"iacaId\": \"de053c77-b2b3-5c7c-0d64-cce9c179ff17\",\n \"active\": true,\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"020a3e27-9ec3-c6f4-2c54-ea9d4765b793\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Maximum number of document signer certificates reached. Please delete an existing certificate before creating a new one.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"020a3e27-9ec3-c6f4-2c54-ea9d4765b793\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Document Signers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all existing Document Signers from the tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Document Signers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"e9f46fb0-58f7-52a4-38e5-909464eeadb7\",\n \"iacaId\": \"617c9b95-ded3-d5a2-f96d-4cfaa22c2b19\",\n \"active\": false,\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n },\n {\n \"id\": \"8058b7cd-997e-36eb-b3ae-e8ad4134957e\",\n \"iacaId\": \"85876fad-0977-c05e-5cd4-96a7d5bb9237\",\n \"active\": false,\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n }\n ],\n \"nextCursor\": \"string\"\n}" + } + ] + }, + { + "name": "Update a Document Signer", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\\\r\\\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\\\r\\\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\\\r\\\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\\\r\\\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\\\r\\\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\\\r\\\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\\\r\\\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\\\r\\\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\\\r\\\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\\\r\\\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\\\r\\\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\\\r\\\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\\\r\\\\nIavC\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing Document Signer by providing its ID and `active` parameter.\n\n> Only available in implementations using unmanaged (external) IACAs.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_START\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_UPDATE_FAIL" + }, + "response": [ + { + "name": "Document Signer updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\\\r\\\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\\\r\\\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\\\r\\\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\\\r\\\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\\\r\\\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\\\r\\\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\\\r\\\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\\\r\\\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\\\r\\\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\\\r\\\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\\\r\\\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\\\r\\\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\\\r\\\\nIavC\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"7a34157c-5ca4-6cc0-af60-6a4021d91ee0\",\n \"iacaId\": \"3a151429-35a0-0b06-32fe-13739c85d623\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\\\r\\\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\\\r\\\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\\\r\\\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\\\r\\\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\\\r\\\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\\\r\\\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\\\r\\\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\\\r\\\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\\\r\\\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\\\r\\\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\\\r\\\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\\\r\\\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\\\r\\\\nIavC\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"notAfter\": \"2034-09-26\",\n \"notBefore\": \"2023-09-30\",\n \"country\": \"US\",\n \"commonName\": \"{tenant-subdomain}.vii.mattr.global Document Signer\",\n \"stateOrProvinceName\": \"US-AL\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\\\r\\\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\\\r\\\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\\\r\\\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\\\r\\\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\\\r\\\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\\\r\\\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\\\r\\\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\\\r\\\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\\\r\\\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\\\r\\\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\\\r\\\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\\\r\\\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\\\r\\\\nIavC\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICbzCCAhSgAwIBAgIKfS7sskyJEh+DOzAKBggqhkjOPQQDAjAiMSAwCQYDVQQG\\\\r\\\\nEwJOWjATBgNVBAMTDEV4YW1wbGUgSUFDQTAeFw0yMzA5MTEyMzM0MjJaFw0yNDA5\\\\r\\\\nMTAyMzM0MjJaMDExLzAJBgNVBAYTAk5aMCIGA1UEAxMbZXhhbXBsZS5jb20gRG9j\\\\r\\\\ndW1lbnQgU2lnbmVyMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7fa+jv9zCtHQ\\\\r\\\\nmKn7o1dS6lBHD5thlhPqjlx7qEfqy8Im9AcQJDal2sr/fUxhHwf/G4ublS7AL04U\\\\r\\\\n73dzr/ozxaOCASEwggEdMAwGA1UdEwEB/wQCMAAwHQYDVR0OBBYEFLdNNPTmPxt0\\\\r\\\\nLqvlZnV/QL86MXOxMB8GA1UdIwQYMBaAFPc04SrKhcQIESQwxltWrvnsCSuqMA4G\\\\r\\\\nA1UdDwEB/wQEAwIAgDAeBgNVHREEFzAVhhNodHRwczovL2V4YW1wbGUuY29tMB4G\\\\r\\\\nA1UdEgQXMBWGE2h0dHBzOi8vZXhhbXBsZS5jb20waQYDVR0fBGIwYDBeoFygWoZY\\\\r\\\\naHR0cHM6Ly9leGFtcGxlLmNvbS92Mi9jcmVkZW50aWFscy9tb2JpbGUvaWFjYXMv\\\\r\\\\nMmU4OWMxNTYtMzFkNS00NzgzLWJkNTktOTA1NWI1ZjhlN2QyL2NybDASBgNVHSUE\\\\r\\\\nCzAJBgcogYxdBQECMAoGCCqGSM49BAMCA0kAMEYCIQCfgn6+QoNfDVelJANl+Jp9\\\\r\\\\ncq7X9paZylfnI6UGr1FM6gIhAIzhiyclDa8+/ZSRfu7KfgGrNRaJ8YQ6vevskJls\\\\r\\\\nIavC\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Document Signer", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Document Signer by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_START\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Document Signer retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"555815d4-4bcc-f18b-663c-62e73dfc1ae9\",\n \"iacaId\": \"de053c77-b2b3-5c7c-0d64-cce9c179ff17\",\n \"active\": true,\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a Document Signer", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing Document Signer by providing its ID.\n\n> Only available in implementations using unmanaged (external) IACAs.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_START\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_DOCUMENT_SIGNER_DELETE_FAIL" + }, + "response": [ + { + "name": "Document Signer deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/document-signers/:documentSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "document-signers", + ":documentSignerId" + ], + "variable": [ + { + "key": "documentSignerId", + "value": "d2c9f2aa-fc69-4fbc-9b85-0c00591d72f6", + "description": "(Required) Document Signer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Document Signers." + }, + { + "name": "Status list signers", + "item": [ + { + "name": "Create a new status list signer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"106df8c8-123e-3547-99d8-d964b1a4a837\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Uses an existing IACA to sign a status list signer (intermediate certificate) that can be used to sign status list tokens.\n\n- Only available in implementations using unmanaged (external) IACAs.\n- A maximum of three Status List Signers can be created per tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_START \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_SUCCESS \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Status list signer created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"106df8c8-123e-3547-99d8-d964b1a4a837\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"217e3af2-376f-3c04-7297-4df2e31def4f\",\n \"active\": false,\n \"iacaId\": \"1bbf906b-74f9-af22-830e-b297a561de2f\",\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n}" + }, + { + "name": "Maximum number of status list signer certificates reached. Please delete an existing certificate before creating a new one.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"iacaId\": \"106df8c8-123e-3547-99d8-d964b1a4a837\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all status list signers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all existing status list signers. \n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_START \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_SUCCESS \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Status list signers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"9a57c5ba-39ea-8ae8-d937-81b8da16658f\",\n \"active\": false,\n \"iacaId\": \"3642ce18-4c61-e50e-09ca-32598a67491a\",\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n },\n {\n \"id\": \"1c192435-9a63-f3e5-5ea9-751da9851114\",\n \"active\": false,\n \"iacaId\": \"6693a8d6-875a-1817-650d-950f5bff8401\",\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a status list signer", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers/:statusListSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers", + ":statusListSignerId" + ], + "variable": [ + { + "key": "statusListSignerId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing status list signer.\n\n> Status list signer operations are only available in implementations using unmanaged (external) IACAs.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_START \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_SUCCESS \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Status list signer retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers/:statusListSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers", + ":statusListSignerId" + ], + "variable": [ + { + "key": "statusListSignerId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"217e3af2-376f-3c04-7297-4df2e31def4f\",\n \"active\": false,\n \"iacaId\": \"1bbf906b-74f9-af22-830e-b297a561de2f\",\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----\"\n}" + } + ] + }, + { + "name": "Update a status list signer", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false,\n \"certificatePem\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers/:statusListSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers", + ":statusListSignerId" + ], + "variable": [ + { + "key": "statusListSignerId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates the status of an existing status list signer.\n\n> Only available in implementations using unmanaged (external) IACAs.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_START \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_SUCCESS \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "Status list signer updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": false,\n \"certificatePem\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers/:statusListSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers", + ":statusListSignerId" + ], + "variable": [ + { + "key": "statusListSignerId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"e1b7a276-6730-778d-7f41-cb425b52b9c7\",\n \"iacaId\": \"0d75918c-84af-d2d4-324a-450b0abb87c0\",\n \"active\": true,\n \"certificatePem\": \"string\",\n \"certificateFingerprint\": \"475DA948E4BA44D9B5BC31AB4B8006113FD5F538\",\n \"certificateData\": {\n \"notBefore\": \"1983-12-18T12:42:08.437Z\",\n \"notAfter\": \"2003-07-19T20:30:53.084Z\",\n \"country\": \"string\",\n \"stateOrProvinceName\": \"string\",\n \"organisationName\": \"string\"\n }\n}" + } + ] + }, + { + "name": "Delete a status list signer", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers/:statusListSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers", + ":statusListSignerId" + ], + "variable": [ + { + "key": "statusListSignerId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing status list signer.\n\n> Only available in implementations using unmanaged (external) IACAs.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_START \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_SUCCESS \n* MOBILE_CREDENTIAL_STATUS_LIST_SIGNER_DELETE_FAIL\n" + }, + "response": [ + { + "name": "No Content", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-list-signers/:statusListSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-list-signers", + ":statusListSignerId" + ], + "variable": [ + { + "key": "statusListSignerId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for managing status list signers." + }, + { + "name": "Status list configuration", + "item": [ + { + "name": "Create a Status list configuration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"docType\": \"DriverLicense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Status list configuration created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"docType\": \"DriverLicense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"docType\": \"Drivers LIcense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"docType\": \"DriverLicense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"body\",\n \"msg\": \"must be a Duration\",\n \"param\": \"timeToLiveDuration\",\n \"value\": \"abc\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Status list configurations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all Status list configurations from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Status list configurations retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"docType\": \"Drivers LIcense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n },\n {\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"docType\": \"Drivers LIcense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Status list configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Status list configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Status list configuration retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"docType\": \"DriverLicense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a Status list configuration", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "Status list configuration updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"983c0a86-204f-4431-9371-f5a22e506599\",\n \"docType\": \"Drivers LIcense\",\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"timeToLiveDuration\": {\n \"days\": 1\n },\n \"expiryDuration\": {\n \"days\": 2\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a Status list configuration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Permanently deletes an existing Status list configuration.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL\n" + }, + "response": [ + { + "name": "Status list configuration deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad request", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Status list configuration is in use by at least one status list\"\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "configurations", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Status list configuration ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing status list configuration." + }, + { + "name": "Status list retrieval", + "item": [ + { + "name": "Retrieve all Status lists", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all existing status lists from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Status lists retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"9ce77f56-ba71-71ab-f54a-f45472d77f9f\",\n \"iacaId\": \"afc09b04-ebe6-0063-b521-63a03467b09e\",\n \"statusListConfigurationId\": \"4f04967a-a2d3-c46c-3444-9d664ba947ba\",\n \"listSize\": 100000,\n \"list\": \"0oRZAu6jEHRtYXR0ci1zdGF0dXNs...\"\n },\n {\n \"id\": \"9ad5b53f-6449-f6d1-fe72-38114963b811\",\n \"iacaId\": \"910013d6-e4b2-0798-c8e4-92d1cc4914ec\",\n \"statusListConfigurationId\": \"0eac6c21-4b75-cbce-1f51-6db3364d2def\",\n \"listSize\": 100000,\n \"list\": \"0oRZAu6jEHRtYXR0ci1zdGF0dXNs...\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Status list", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Status list and its signed token by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Status list retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"a5ef9ae7-d262-b6bc-3710-d0bc0345609f\",\n \"iacaId\": \"a4a7dd45-fb9a-e6ec-8389-636855766ea5\",\n \"statusListConfigurationId\": \"1d51910e-8549-882a-945d-4870bc8e4bab\",\n \"listSize\": 100000,\n \"list\": \"0oRZAu6jEHRtYXR0ci1zdGF0dXNs...\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list unique identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Status list token", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/cwt" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId", + "token" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves the Status list token in CWT format. This public end point returns a token which contains a compressed, signed list of credential statuses. Relying parties\ncan use this token to check the revocation status of an mDoc that references this Status list.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Status list token retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/cwt" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId", + "token" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/cwt" + } + ], + "cookie": [], + "body": "string" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId", + "token" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + }, + { + "name": "Status list expired", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + ":statusListId", + "token" + ], + "variable": [ + { + "key": "statusListId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Status list identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Status list distribution", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/distribution", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "distribution" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an object that details all existing Status lists tokens on the tenant. This public endpoint allows a relying party to consume and cache status lists. Each list\nin the response includes a URL where its token can be retrieved. Status list tokens that were signed by expired IACAs are excluded from the response.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_START\n* MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_FAIL\n" + }, + "response": [ + { + "name": "Status lists retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/distribution", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "status-lists", + "distribution" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"status_lists\": {\n \"uri\": \"https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}\"\n }\n },\n {\n \"status_lists\": {\n \"uri\": \"https://learn.vii.au01.mattr.global/v2/credentials/mobile/status-lists/{statusListId}\"\n }\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for retrieving status lists." + }, + { + "name": "mDocs status", + "item": [ + { + "name": "Update mDoc status", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"valid\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Sets the status of an existing mDoc by providing its `credentialId` and the new status. Status can only be **valid**, **suspended** or **invalid**.\n\nOnce an mDoc's status is updated to **invalid**, it cannot be updated again to any other value.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_SET_START\n* MOBILE_CREDENTIAL_STATUS_SET_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_SET_FAIL" + }, + "response": [ + { + "name": "Credential status updated", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"valid\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"valid\"\n}" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"valid\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Invalid value\",\n \"param\": \"credentialId\",\n \"value\": \"abc\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"status\": \"valid\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve mDoc status", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves the status of an existing mDoc by providing its `credentialId`.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Credential status retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"valid\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":credentialId", + "status" + ], + "variable": [ + { + "key": "credentialId", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) mDoc identifier" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing mDocs status." + }, + { + "name": "Delete mDoc metadata", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) mDoc ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes all stored data for an existing mDoc that matches the provided ID.\n\n> Removed credential data cannot be recovered.\n\n### **Analytic events**\n* USER_CREDENTIAL_DELETE_START\n* USER_CREDENTIAL_DELETE_SUCCESS\n* USER_CREDENTIAL_DELETE_FAIL" + }, + "response": [ + { + "name": "mDoc metadata deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) mDoc ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Invalid id parameter format", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) mDoc ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) mDoc ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing mDocs credentials." + }, + { + "name": "CWT credentials management", + "item": [ + { + "name": "Delete CWT credential metadata", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.\n\nNote that only metadata of revocable credentials or credentials issued via the OpenID4VCI flow is saved.\n\n> Deleted metadata cannot be recovered." + }, + "response": [ + { + "name": "Credential metadata deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all CWT credential revocation lists", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "revocation-lists" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all CWT credential revocation lists on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_START\n* CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Revocation lists retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "revocation-lists" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"nextCursor\": \"string\",\n \"data\": [\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n },\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n {\n \"nextCursor\": \"string\",\n \"data\": [\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n },\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n }\n ]\n }\n]" + } + ] + }, + { + "name": "Retrieve CWT credential revocation list", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/cwt" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists/:listId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "revocation-lists", + ":listId" + ], + "variable": [ + { + "key": "listId", + "value": "string", + "description": "(Required) The unique identifier of the Revocation List you wish to retrieve." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a CWT credential revocation list by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Revocation list retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/cwt" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists/:listId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "revocation-lists", + ":listId" + ], + "variable": [ + { + "key": "listId", + "value": "string", + "description": "(Required) The unique identifier of the Revocation List you wish to retrieve." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/cwt" + } + ], + "cookie": [], + "body": "string" + } + ] + }, + { + "name": "Update CWT credential revocation status", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates the credential status as revoked (invalid) or unrevoked (valid).\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_START\n* CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_SUCCESS\n* CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_FAIL" + }, + "response": [ + { + "name": "Revocation status updated", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"isRevoked\": true\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve CWT credential revocation status", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve the revocation status of a CWT credential by providing its ID." + }, + "response": [ + { + "name": "Revocation status retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"isRevoked\": false\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing CWT credentials." + }, + { + "name": "Semantic CWT credentials management", + "item": [ + { + "name": "Delete Semantic CWT credential metadata", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.\n\nNote that only metadata of revocable credentials or credentials issued via the OpenID4VCI flow is saved.\n\n> Deleted metadata cannot be recovered." + }, + "response": [ + { + "name": "Credential metadata deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Semantic CWT credential revocation lists", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "revocation-lists" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all Semantic CWT credential revocation lists on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Revocation lists retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "revocation-lists" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"nextCursor\": \"string\",\n \"data\": [\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n },\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n {\n \"nextCursor\": \"string\",\n \"data\": [\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n },\n {\n \"id\": \"string\",\n \"issuer\": \"string\",\n \"url\": \"string\"\n }\n ]\n }\n]" + } + ] + }, + { + "name": "Retrieve Semantic CWT credential revocation list", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/cwt" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists/:listId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "revocation-lists", + ":listId" + ], + "variable": [ + { + "key": "listId", + "value": "string", + "description": "(Required) The unique identifier of the revocation list you wish to retrieve." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a Semantic CWT credential revocation list by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Revocation list retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/cwt" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists/:listId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "revocation-lists", + ":listId" + ], + "variable": [ + { + "key": "listId", + "value": "string", + "description": "(Required) The unique identifier of the revocation list you wish to retrieve." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "application/cwt" + } + ], + "cookie": [], + "body": "string" + } + ] + }, + { + "name": "Update Semantic CWT credential revocation status", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier (`jti`)" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates the credential status as revoked (invalid) or unrevoked (valid).\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_START\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_FAIL" + }, + "response": [ + { + "name": "Revocation status updated", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier (`jti`)" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"isRevoked\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier (`jti`)" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve Semantic CWT credential revocation status", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier (`jti`)" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve the revocation status of a Semantic CWT credential by providing its ID." + }, + "response": [ + { + "name": "Revocation status retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier (`jti`)" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"isRevoked\": false\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Unique credential identifier (`jti`)" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Semantic CWT credentials." + }, + { + "name": "JSON credentials management", + "item": [ + { + "name": "Retrieve all credential data", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic?tag=identifier123&type=AlumniCredential&limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic" + ], + "query": [ + { + "key": "tag", + "value": "identifier123", + "description": "Optional tag to filter on." + }, + { + "key": "type", + "value": "AlumniCredential", + "description": "Optional credential type to filter on." + }, + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns all available data for existing credentials:\n- For credentials that were created with the `persist` flag set to `true`, the response contains both the credential and its metadata.\n- For credentials that were created with the persist flag set to `false`, the response only contains the metadata (`id`, `tag`, `credentialStatus`, `issuanceDate`).\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_START\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Credentials data retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic?tag=identifier123&type=AlumniCredential&limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic" + ], + "query": [ + { + "key": "tag", + "value": "identifier123" + }, + { + "key": "type", + "value": "AlumniCredential" + }, + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"873277c0-a162-11ea-8a1d-a111119347e6\",\n \"credential\": {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuer\": {\n \"id\": \"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5\",\n \"name\": \"https://tenant.vii.mattr.global\"\n },\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"id\": \"did:key:z6Mkvji7zrwyFATXUzGNBSCnrPaZy7H3BWUnihrHvZdkEd9y\",\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5#z6Mkvji7zrwyFATXUzGNBSCnrPaZy7H3BWUnihrHvZdkEd9y\"\n }\n },\n \"tag\": \"identifier123\",\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\"\n },\n {\n \"id\": \"9043aa74-eb08-11ea-adc1-0242ac120002\",\n \"tag\": \"identifier124\",\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\",\n \"revocationListIndex\": 1\n },\n \"issuanceDate\": \"2020-10-06T03:21:02.397Z\"\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic?tag=identifier123&type=AlumniCredential&limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic" + ], + "query": [ + { + "key": "tag", + "value": "identifier123" + }, + { + "key": "type", + "value": "AlumniCredential" + }, + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve credential data", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns all available data for an existing credential that matches the provided ID:\n- For credentials that were created with the `persist` flag set to `true`, the response contains both the credential and its metadata.\n- For credentials that were created with the persist flag set to `false`, the response only contains the metadata (`id`, `tag`, `credentialStatus`, `issuanceDate`)\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_START\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Credential data retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"873277c0-a162-11ea-8a1d-a111119347e6\",\n \"credential\": {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\"\n },\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\",\n \"revocationListIndex\": 4\n },\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n }\n },\n \"tag\": \"identifier123\",\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\",\n \"revocationListIndex\": 4\n },\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete credential data", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes all stored data for an existing credential that matches the provided ID. If the credential is revocable, it will also be permanently revoked.\n\n> Removed credential data cannot be recovered.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_DELETE_START\n* CREDENTIAL_WEB_SEMANTIC_DELETE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_DELETE_FAIL" + }, + "response": [ + { + "name": "Credential deleted and revoked if revocable", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Set credential revocation status", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Sets the revocation status of the credential that matches the provided ID as `true` (revoked) or `false` (unrevoked).\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_START\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_FAIL\n" + }, + "response": [ + { + "name": "Revocation status updated", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"isRevoked\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve credential revocation status", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns the revocation status of the credential matching the provided ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_START\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Credential status", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"isRevoked\": false\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status" + ], + "variable": [ + { + "key": "id", + "value": "a80a5e7e-1972-4be6-8a4e-2adf09badf24", + "description": "(Required) Credential ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve revocation list", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/revocation-lists/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "revocation-lists", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "cc641396-3750-43c8-b8b8-f30d74eb3fb3", + "description": "(Required) Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/v1/revocation-lists/` is what you're looking for" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns the revocation list matching the provided ID." + }, + "response": [ + { + "name": "Revocation list retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/revocation-lists/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "revocation-lists", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "cc641396-3750-43c8-b8b8-f30d74eb3fb3", + "description": "(Required) Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/v1/revocation-lists/` is what you're looking for" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\",\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://w3id.org/vc-revocation-list-2020/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"RevocationList2020Credential\"\n ],\n \"issuer\": \"did:web:organization.com\",\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"type\": \"RevocationList2020\",\n \"encodedList\": \"H4sIAAAAAAAAA-3BMQEAAADCoPVPbQwfoAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com#CU6dJt9p8t\"\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/revocation-lists/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "revocation-lists", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "cc641396-3750-43c8-b8b8-f30d74eb3fb3", + "description": "(Required) Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/v1/revocation-lists/` is what you're looking for" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Create a revocation message payload", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"did:web:organization.com\",\n \"to\": [\n \"did:key:subjectDid1\",\n \"did:key:subjectDid2\",\n \"did:key:subjectDid3\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status/notification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status", + "notification" + ], + "variable": [ + { + "key": "id", + "value": "873277c0-a162-11ea-8a1d-a111119347e6", + "description": "(Required) Unique identifier for the credential whose status has changed." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a message in JWM format that can be used to notify subjects based on their credential revocation status change.\n\nTo send a notification to the Subject DID holder, use the returned payload with the [encrypt](#operation/encryptMessage) and [send](#operation/sendMessage) endpoints.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_START\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_FAIL" + }, + "response": [ + { + "name": "Revocation message payload created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"from\": \"did:web:organization.com\",\n \"to\": [\n \"did:key:subjectDid1\",\n \"did:key:subjectDid2\",\n \"did:key:subjectDid3\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status/notification", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + ":id", + "revocation-status", + "notification" + ], + "variable": [ + { + "key": "id", + "value": "873277c0-a162-11ea-8a1d-a111119347e6", + "description": "(Required) Unique identifier for the credential whose status has changed." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"type\": \"string\",\n \"to\": [\n {\n \"string\": 1019.2667677413691\n },\n {\n \"string\": \"string\"\n }\n ],\n \"from\": \"did:web:organization.com\",\n \"created_time\": 2749.2970616746225,\n \"body\": {\n \"revocationListCredential\": \"string\",\n \"revocationListIndex\": \"string\",\n \"isRevoked\": true\n }\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing JSON credentials." + } + ] + }, + { + "name": "Credential verification", + "item": [ + { + "name": "mDocs verification", + "item": [ + { + "name": "Trusted issuers", + "item": [ + { + "name": "Create a trusted issuer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Add a new mDocs trusted issuer, to be used in online presentation workflows.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_FAIL\n" + }, + "response": [ + { + "name": "Trusted issuer created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"ed74319e-72a6-4401-b3a5-94e980fbebea\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\",\n \"certificateData\": {\n \"notAfter\": \"2033-09-23\",\n \"notBefore\": \"2023-09-23\",\n \"country\": \"1989-06-04\",\n \"commonName\": \"1982-06-29\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all trusted issuers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all mDocs trusted issuers from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "Trusted issuers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"ed74319e-72a6-4401-b3a5-94e980fbebea\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\",\n \"certificateData\": {\n \"notAfter\": \"2033-09-23\",\n \"notBefore\": \"2023-09-23\",\n \"country\": \"2023-03-11\",\n \"commonName\": \"1973-08-20\"\n }\n },\n {\n \"id\": \"ed74319e-72a6-4401-b3a5-94e980fbebea\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\",\n \"certificateData\": {\n \"notAfter\": \"2033-09-23\",\n \"notBefore\": \"2023-09-23\",\n \"country\": \"1958-10-16\",\n \"commonName\": \"2006-10-02\"\n }\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a trusted issuer", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing trusted issuer from your tenant by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_FAIL\n" + }, + "response": [ + { + "name": "Trusted issuer retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"ed74319e-72a6-4401-b3a5-94e980fbebea\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\\\r\\\\nMIICUDCCAfWgAwIBAgIKVVqBlVonWFs3lTAKBggqhkjOPQQDAjAkMQswCQYDVQQG\\\\r\\\\nEwJOWjEVMBMGA1UEAwwMRXhhbXBsZSBJQUNBMB4XDTI0MDExMTAzMjYwMFoXDTM0\\\\r\\\\nMDEwODAzMjYwMFowJDELMAkGA1UEBhMCTloxFTATBgNVBAMMDEV4YW1wbGUgSUFD\\\\r\\\\nQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABOHxm9MYkCvIvZc/MyoWGul8+tla\\\\r\\\\nFSSRVkDllFERbO/Tg7DOj4CJfYrhDJEuV04eRgcowBDhr9W/bvnTMZMa/RijggEN\\\\r\\\\nMIIBCTASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4E\\\\r\\\\nFgQUpS3hOCbmCUwu8n91X9CLS682cOkwOwYDVR0SBDQwMoYwaHR0cHM6Ly9odWRz\\\\r\\\\nb24tdGVuYW50LTAwMS52aWkuYXUzMDEubWF0dHJsYWJzLmlvMIGGBgNVHR8EfzB9\\\\r\\\\nMHugeaB3hnVodHRwczovL2h1ZHNvbi10ZW5hbnQtMDAxLnZpaS5hdTMwMS5tYXR0\\\\r\\\\ncmxhYnMuaW8vdjIvY3JlZGVudGlhbHMvbW9iaWxlL2lhY2FzL2VkNzQzMTllLTcy\\\\r\\\\nYTYtNDQwMS1iM2E1LTk0ZTk4MGZiZWJlYS9jcmwwCgYIKoZIzj0EAwIDSQAwRgIh\\\\r\\\\nAJxWGZvntq+hymL7zWwrlZo1Jz1+lWglu/MESdmUhTNFAiEAg+x5e3TzBxgHneIM\\\\r\\\\nVpTmZNOyZI3Hn17WRKkyKSg+5/8=\\\\r\\\\n-----END CERTIFICATE-----\\\\r\\\\n\",\n \"certificateData\": {\n \"notAfter\": \"2033-09-23\",\n \"notBefore\": \"2023-09-23\",\n \"country\": \"1989-06-04\",\n \"commonName\": \"1982-06-29\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a trusted issuer", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing trusted issuer by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_FAIL\n" + }, + "response": [ + { + "name": "Trusted issuer deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "mobile", + "trusted-issuers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "3948c40e-6e19-4ffc-933c-91f643f24264", + "description": "(Required) Trusted issuer ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all trusted issuers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/trusted-issuers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "trusted-issuers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all configured trusted issuers.\n\nThis endpoint is unprotected, public facing and can be used by any party wishing to retrieve the list of trusted issuers.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_TRUSTED_ISSUERS_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Trusted issuers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/trusted-issuers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "trusted-issuers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"iacas\": [\n {\n \"certificate\": \"string\"\n },\n {\n \"certificate\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing trusted issuers for mDocs verification." + }, + { + "name": "Verifier root CA certificates", + "item": [ + { + "name": "Create a verifier root CA certificate", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"string\",\n \"notBefore\": \"1955-10-12T13:20:20.567Z\",\n \"notAfter\": \"1989-10-07T11:50:10.860Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a verifier root CA certificate to be used as part of mDocs online verification workflows.\n- A maximum of three Verifier root CA certificates can be created per tenant.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Verifier root CA certificate created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"string\",\n \"notBefore\": \"1955-10-12T13:20:20.567Z\",\n \"notAfter\": \"1989-10-07T11:50:10.860Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0\",\n \"certificateData\": {\n \"commonName\": \"Example Verifier\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"string\"\n },\n \"active\": true,\n \"isManaged\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"string\",\n \"notBefore\": \"1955-10-12T13:20:20.567Z\",\n \"notAfter\": \"1989-10-07T11:50:10.860Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Maximum number of verifier root certificates reached. Please delete an existing certificate before creating a new one.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"string\",\n \"notBefore\": \"1955-10-12T13:20:20.567Z\",\n \"notAfter\": \"1989-10-07T11:50:10.860Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"value\": \"string\",\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all verifier root CA certificates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all existing verifier root CA certificates.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Verifier root CA certificates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"string\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0\",\n \"certificateData\": {\n \"commonName\": \"Example Verifier\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": 446\n },\n \"active\": true,\n \"isManaged\": false\n },\n {\n \"id\": \"string\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0\",\n \"certificateData\": {\n \"commonName\": \"Example Verifier\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": 6709.206007467232\n },\n \"active\": true,\n \"isManaged\": true\n }\n ],\n \"nextCursor\": \"string\"\n}" + } + ] + }, + { + "name": "Update a verifier root CA certificate", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing verifier root CA certificate.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "Verifier root CA certificate updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0\",\n \"certificateData\": {\n \"commonName\": \"Example Verifier\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"string\"\n },\n \"active\": true,\n \"isManaged\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a verifier root CA certificate", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing verifier root CA certificate.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Verifier root CA certificate retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"string\",\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"a3b2c1d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0\",\n \"certificateData\": {\n \"commonName\": \"Example Verifier\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"organisationName\": \"string\"\n },\n \"active\": true,\n \"isManaged\": true\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a verifier root CA certificate", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing verifier root CA certificate.\n\n### **Analytic events**\n* PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_START\n* PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_SUCCESS\n* PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Verifier root CA certificate deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "ca", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier root CA certificate." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Verifier root CA certificates for mDocs verification." + }, + { + "name": "Verifier applications", + "item": [ + { + "name": "Create verifier application", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates an mDocs online verifier application.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_FAIL" + }, + "response": [ + { + "name": "Verifier application created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all verifier applications", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all configured mDocs online verifier applications.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Verifier applications retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ]\n },\n {\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ]\n }\n ]\n}" + } + ] + }, + { + "name": "Update verifier application", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing mDocs online verifier application.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_FAIL" + }, + "response": [ + { + "name": "Verifier application updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ],\n \"resultAvailableInFrontChannel\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a verifier application", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing mDocs online verifier application.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Verifier application retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"https://example-verifier-web-application.com/presentation/callback\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"https://example-logo-image-url.com\",\n \"altText\": \"Logo image\"\n },\n \"headerText\": \"Share your information.\",\n \"bodyText\": \"Please scan the QR code to the right to provide information required for this interaction.\",\n \"privacyPolicyUrl\": \"https://example-privacy-policy.com\",\n \"primaryColorHex\": \"#FFFFFF\"\n }\n },\n \"domain\": \"example-verifier-web-application.com\",\n \"type\": \"web\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"example-verifier-web-application.com\"\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a verifier application", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Removes an existing mDocs online verifier application.\n\n### **Analytic events**\n* PRESENTATION_VERIFIER_APPLICATION_DELETE_START\n* PRESENTATION_VERIFIER_APPLICATION_DELETE_SUCCESS\n* PRESENTATION_VERIFIER_APPLICATION_DELETE_FAIL" + }, + "response": [ + { + "name": "Verifier application deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "applications", + ":applicationId" + ], + "variable": [ + { + "key": "applicationId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the verifier application." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Verifier applications for mDocs verification." + }, + { + "name": "Wallet providers", + "item": [ + { + "name": "Create wallet provider", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_FAIL" + }, + "response": [ + { + "name": "Wallet provider created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"e63a2e46-5afa-48f9-bcc2-2114cf5f331b\",\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all wallet providers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all existing wallet providers that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Wallet providers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"id\": \"e63a2e46-5afa-48f9-bcc2-2114cf5f331b\",\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n },\n {\n \"id\": \"e63a2e46-5afa-48f9-bcc2-2114cf5f331b\",\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n }\n]" + } + ] + }, + { + "name": "Update a wallet provider", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_FAIL" + }, + "response": [ + { + "name": "Wallet provider updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"e63a2e46-5afa-48f9-bcc2-2114cf5f331b\",\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a wallet provider", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Wallet provider retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"e63a2e46-5afa-48f9-bcc2-2114cf5f331b\",\n \"name\": \"Example wallet provider\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"com-example.wallet://\"\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a wallet provider", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* PRESENTATION_WALLET_PROVIDER_DELETE_START\n* PRESENTATION_WALLET_PROVIDER_DELETE_SUCCESS\n* PRESENTATION_WALLET_PROVIDER_DELETE_FAIL" + }, + "response": [ + { + "name": "Wallet provider deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "wallet-providers", + ":walletProviderId" + ], + "variable": [ + { + "key": "walletProviderId", + "value": "281d20b3-42a3-40dd-b29a-115ff32b02b7", + "description": "(Required) Unique identifier for the wallet provider." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Wallet providers for mDocs verification." + }, + { + "name": "Apple Identity Access certificates", + "item": [ + { + "name": "Create an Apple Identity Access CSR", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates an Apple Identity Access Certificate Signing Request (CSR) that can be uploaded to the Apple Developer Portal.\n\nThis certificate contains the public key that will be used to decrypt the response from the Apple Wallet.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_START\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Apple Identity Access CSR created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"fd44e792-45ac-11f0-bef8-bb24f133065e\",\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\",\n \"csrPem\": \"string\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Apple Identity Access CSRs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all Apple Identity Access CSRs created by the tenant.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Apple Identity Access CSRs retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"fd44e792-45ac-11f0-bef8-bb24f133065e\",\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\",\n \"csrPem\": \"string\"\n },\n {\n \"id\": \"fd44e792-45ac-11f0-bef8-bb24f133065e\",\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\",\n \"csrPem\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an Apple Identity Access CSR", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing Apple Identity Access CSR.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Apple Identity Access Certificate CSR retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"fd44e792-45ac-11f0-bef8-bb24f133065e\",\n \"teamId\": \"A2B3C4D5E6\",\n \"merchantId\": \"com.domain.subdomain\",\n \"csrPem\": \"string\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an Apple Identity Access CSR", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing Apple Identity Access CSR.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_START\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_SUCCESS\n* CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Apple Identity Access Certificate CSR deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/apple-identity-access-certificates/:certificateId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "apple-identity-access-certificates", + ":certificateId" + ], + "variable": [ + { + "key": "certificateId", + "value": "673a20c3-97a3-40dd-b29a-115ff32b02c3", + "description": "(Required) Unique identifier for the Apple Identity Access CSR." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Apple Identity Access certificates for mDocs verification." + }, + { + "name": "mDocs presentation sessions", + "item": [ + { + "name": "Retrieve presentation session result", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/sessions/:sessionId/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "sessions", + ":sessionId", + "result" + ], + "variable": [ + { + "key": "sessionId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Session ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves the result of an online presentation session by providing the session's ID.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Session result retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/sessions/:sessionId/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "sessions", + ":sessionId", + "result" + ], + "variable": [ + { + "key": "sessionId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Session ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"sessionId\": \"string\",\n \"challenge\": \"string\",\n \"credentialQuery\": [],\n \"credentials\": [\n {\n \"docType\": \"string\",\n \"validityInfo\": {\n \"signed\": \"string\",\n \"validFrom\": \"string\",\n \"validUntil\": \"string\",\n \"expectedUpdate\": \"string\"\n },\n \"claims\": {},\n \"claimErrors\": {},\n \"branding\": {\n \"name\": \"Example Branding\",\n \"description\": \"Example Branding Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": {\n \"format\": \"svg\",\n \"data\": \"aWNvbg==\"\n },\n \"issuerLogo\": {\n \"format\": \"svg\",\n \"data\": \"aWNvbg==\"\n },\n \"issuerIcon\": {\n \"format\": \"svg\",\n \"data\": \"aWNvbg==\"\n }\n },\n \"issuerInfo\": {\n \"commonName\": \"string\",\n \"trustedIssuerId\": \"string\"\n },\n \"verificationResult\": {\n \"verified\": true,\n \"reason\": {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n },\n \"ecosystemValidation\": {\n \"validated\": false,\n \"policyVersion\": \"string\",\n \"failReasons\": [\n {\n \"type\": \"string\",\n \"message\": \"string\"\n },\n {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n }\n },\n {\n \"docType\": \"string\",\n \"validityInfo\": {\n \"signed\": \"string\",\n \"validFrom\": \"string\",\n \"validUntil\": \"string\",\n \"expectedUpdate\": \"string\"\n },\n \"claims\": {},\n \"claimErrors\": {},\n \"branding\": {\n \"name\": \"Example Branding\",\n \"description\": \"Example Branding Description\",\n \"backgroundColor\": \"#FFFFFF\",\n \"watermarkImage\": {\n \"format\": \"svg\",\n \"data\": \"aWNvbg==\"\n },\n \"issuerLogo\": {\n \"format\": \"svg\",\n \"data\": \"aWNvbg==\"\n },\n \"issuerIcon\": {\n \"format\": \"svg\",\n \"data\": \"aWNvbg==\"\n }\n },\n \"issuerInfo\": {\n \"commonName\": \"string\",\n \"trustedIssuerId\": \"string\"\n },\n \"verificationResult\": {\n \"verified\": false,\n \"reason\": {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n },\n \"ecosystemValidation\": {\n \"validated\": false,\n \"policyVersion\": \"string\",\n \"failReasons\": [\n {\n \"type\": \"string\",\n \"message\": \"string\"\n },\n {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n ],\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n }\n }\n ],\n \"credentialErrors\": [\n {\n \"docType\": \"string\",\n \"errorCode\": \"string\"\n },\n {\n \"docType\": \"string\",\n \"errorCode\": \"string\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/sessions/:sessionId/result", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "sessions", + ":sessionId", + "result" + ], + "variable": [ + { + "key": "sessionId", + "value": "fa170c6c-71a8-c874-e034-8a2e90c07e06", + "description": "(Required) Session ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing mDocs presentation sessions." + }, + { + "name": "mDocs web presentation sessions", + "item": [], + "description": "Specifies paths and operations for managing mDocs web presentation sessions." + }, + { + "name": "Verification request signers", + "item": [ + { + "name": "Create a Verification request signer", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\",\n \"caType\": \"external\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a Verification request signer.\n- Only available in implementations using unmanaged (external) Verifier root CA certificates.\n- A maximum of five Verification request signers can be created per tenant.\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_CREATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Verification request signer created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\",\n \"caType\": \"external\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"caType\": \"external\",\n \"csrPem\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE REQUEST-----\",\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\",\n \"active\": false\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\",\n \"caType\": \"external\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"caId\": \"b0aae560-10e7-4247-8e96-7cdd3578a1e2\",\n \"caType\": \"external\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all Verification request signers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves all Verification request signers.\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Verification request signers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"data\": [\n {\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"caType\": \"apple\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"subjectAlternativeNames\": [\n {\n \"type\": 5366,\n \"value\": \"string\"\n },\n {\n \"type\": 7944,\n \"value\": \"string\"\n }\n ]\n }\n },\n {\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"caType\": \"mattr\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"subjectAlternativeNames\": [\n {\n \"type\": 4171,\n \"value\": \"string\"\n },\n {\n \"type\": 4572,\n \"value\": \"string\"\n }\n ]\n }\n }\n ],\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a Verification request signer", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates a Verification request signer by:\n- Providing a Verification Request Signer Certificate (VRSC) in PEM format that matches its Certificate Signing Request (CSR).\n- Activating or deactivating the VRSC signer. Only VRSC signers with a valid PEM certificate can be activated.\n- The `certificatePem` field becomes immutable after it's updated for the first time.\n\n> Only available in implementations using unmanaged (external) Verifier root CA certificates.\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_UPDATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "Verification request signer updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"caType\": \"apple\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"subjectAlternativeNames\": [\n {\n \"type\": 246,\n \"value\": \"string\"\n },\n {\n \"type\": 485,\n \"value\": \"string\"\n }\n ]\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a Verification request signer", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes a Verification request signer.\n\n> Only available in implementations using unmanaged (external) Verifier root CA certificates.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_DELETE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_DELETE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Verification request signer deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a Verification request signer", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves a Verification request signer.\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_SIGNER_CERTIFICATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Verification request signer retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"782f1885-c7c2-4459-8426-b6d7c111b0b1\",\n \"caType\": \"apple\",\n \"active\": true,\n \"certificatePem\": \"-----BEGIN CERTIFICATE-----\\nMIIDXTCCAkWgAwIBAgIJAL5...\\n-----END CERTIFICATE-----\",\n \"certificateFingerprint\": \"f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172\",\n \"certificateData\": {\n \"commonName\": \"example.com\",\n \"country\": \"US\",\n \"notAfter\": \"2024-10-22T00:00:00Z\",\n \"notBefore\": \"2023-10-22T00:00:00Z\",\n \"subjectAlternativeNames\": [\n {\n \"type\": 246,\n \"value\": \"string\"\n },\n {\n \"type\": 485,\n \"value\": \"string\"\n }\n ]\n }\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/presentations/certificates/verifier-signers/:verifierSignerId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "presentations", + "certificates", + "verifier-signers", + ":verifierSignerId" + ], + "variable": [ + { + "key": "verifierSignerId", + "value": "b0aae560-10e7-4247-8e96-7cdd3578a1e2", + "description": "(Required) Unique identifier of the Verification request signer." + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing Verification request signers." + } + ], + "description": "Specifies paths and operations for verifying mDocs credentials." + }, + { + "name": "CWT credentials verification", + "item": [ + { + "name": "Verify a CWT credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Verify a CWT credential by providing the encoded payload and specifying verification options.\n\nYou can provide a valid CWT credential as either an encoded string or a QR code in a PDF document or an image file.\n\nStandard checks performed on all verification requests:\n- Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`.\n- Decoded payload structure is a valid CWT credential.\n- Issuer DID can be used to resolve its `did.json` document.\n- Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with.\n\nOptional parameter checks:\n- Credential was issued by a trusted issuer.\n- Current time is after the beginning of the credential validity period.\n- Current time is not after the end of the credential validity period.\n- Credential has not been revoked.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_VERIFY_START\n* CREDENTIAL_COMPACT_VERIFY_SUCCESS\n* CREDENTIAL_COMPACT_VERIFY_FAIL" + }, + "response": [ + { + "name": "Verification completed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verified\": false,\n \"decoded\": {\n \"iss\": \"did:web:organization.com\",\n \"nbf\": 1645743759,\n \"exp\": 1646743759,\n \"iat\": 1645743759,\n \"jti\": \"6tVMmKodQNaLywW6NGA2aA\",\n \"type\": \"CredentialType\",\n \"property1\": \"...\",\n \"property2\": \"...\"\n },\n \"error\": {\n \"type\": \"string\",\n \"message\": \"string\",\n \"details\": {}\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Payload Too Large", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Request Entity Too Large", + "code": 413, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Unsupported Media Type", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Unsupported Media Type", + "code": 415, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for verifying CWT credentials." + }, + { + "name": "Semantic CWT credentials verification", + "item": [ + { + "name": "Verify a Semantic CWT credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "multipart/form-data" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Verify a Semantic CWT credential by providing the encoded payload and specifying verification options.\n\nYou can provide a valid Semantic CWT credential as either an encoded string or a QR code in a PDF document or an image file.\n\nStandard checks performed on all verification requests:\n- Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`.\n- Decoded payload CWT structure and attributes can be validated.\n- Remote context schema can be resolved and validate claims can be dereferenced.\n- Issuer DID can be used to resolve its `did.json` document.\n- Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with.\n\nOptional parameter checks:\n- Credential was issued by a trusted issuer.\n- Current time is after the beginning of the credential validity period.\n- Current time is not after the end of the credential validity period.\n- Credential has not been revoked.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_VERIFY_START\n* CREDENTIAL_COMPACT_SEMANTIC_VERIFY_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_VERIFY_FAIL" + }, + "response": [ + { + "name": "Verification completed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verified\": false,\n \"reason\": [\n {\n \"type\": \"IssuerNotTrusted\",\n \"msg\": \"...\"\n }\n ],\n \"decoded\": {\n \"jti\": \"urn:uuid:03ae824d-7179-4c01-aa29-f80ba93122d2\",\n \"iss\": \"did:web:xxx\",\n \"nbf\": 1649037604,\n \"vc\": {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://example.com/credentials/pass\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"PublicCovidPass\"\n ],\n \"credentialSubject\": {\n \"givenName\": \"Jack\",\n \"familyName\": \"Sparrow\",\n \"dob\": \"1979-04-14\"\n }\n }\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Payload Too Large", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Request Entity Too Large", + "code": 413, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Unsupported Media Type", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "file", + "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", + "type": "file", + "src": [] + }, + { + "key": "trustedIssuers", + "value": "[\"did:web:example.com\",\"did:web:example.com\"]", + "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", + "type": "text" + }, + { + "key": "assertValidFrom", + "value": "true", + "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", + "type": "text" + }, + { + "key": "assertValidUntil", + "value": "true", + "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", + "type": "text" + }, + { + "key": "checkRevocation", + "value": "true", + "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", + "type": "text" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "compact-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Unsupported Media Type", + "code": 415, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "Specifies paths and operations for verifying Semantic CWT credentials." + }, + { + "name": "JSON credentials verification", + "item": [ + { + "name": "Verify a JSON credential", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://mattr.global/contexts/vc-extensions/v2\",\n \"https://w3id.org/vc-revocation-list-2020/v1\",\n \"https://optionalschema.example/\"\n ],\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n },\n \"checkRevocation\": true,\n \"assertValidFrom\": true,\n \"assertValidUntil\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Verify a JSON credential by providing its payload. The credential is verified against the following criteria:\n- Issuer DID can be resolved, so that the referenced DID Document is available and valid and the public key is obtainable.\n- Proof is valid and the credential has not been tampered with.\n- JSON-LD context is valid for subject claims.\n\nOptional verification checks:\n- If `assertExpiry` is set to `true` and the credential has a set expiration date, verification will fail if the expiration date has passed.\n- If `checkRevocation` is set to `true` and the provided credential contains a revocation status list, verification will fail if the credential has been set to `revoked`.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_VERIFY_START\n* CREDENTIAL_WEB_SEMANTIC_VERIFY_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_VERIFY_FAIL" + }, + "response": [ + { + "name": "Verification completed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://mattr.global/contexts/vc-extensions/v2\",\n \"https://w3id.org/vc-revocation-list-2020/v1\",\n \"https://optionalschema.example/\"\n ],\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n },\n \"checkRevocation\": true,\n \"assertValidFrom\": true,\n \"assertValidUntil\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verified\": false,\n \"reason\": {\n \"type\": \"string\",\n \"message\": \"string\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"payload\": {\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://mattr.global/contexts/vc-extensions/v2\",\n \"https://w3id.org/vc-revocation-list-2020/v1\",\n \"https://optionalschema.example/\"\n ],\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n },\n \"checkRevocation\": true,\n \"assertValidFrom\": true,\n \"assertValidUntil\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Create a presentation template", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"required\": true,\n \"reason\": \"We need you to prove your alumni membership.\",\n \"example\": {\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"type\": \"AlumniCredential\",\n \"trustedIssuer\": [\n {\n \"required\": true,\n \"issuer\": \"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5\"\n }\n ]\n }\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a presentation template defining what type of credential is required for a particular verification workflow. Presentation templates are used to create presentation requests that are shared with a specific holder.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_FAIL" + }, + "response": [ + { + "name": "Presentation template created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"required\": true,\n \"reason\": \"We need you to prove your alumni membership.\",\n \"example\": {\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"type\": \"AlumniCredential\",\n \"trustedIssuer\": [\n {\n \"required\": true,\n \"issuer\": \"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5\"\n }\n ]\n }\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"required\": true,\n \"reason\": \"We need you to prove your alumni membership.\",\n \"example\": {\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"type\": \"AlumniCredential\",\n \"trustedIssuer\": [\n {\n \"required\": true,\n \"issuer\": \"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5\"\n }\n ]\n }\n }\n ]\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"required\": true,\n \"reason\": \"We need you to prove your alumni membership.\",\n \"example\": {\n \"@context\": [\n \"https://optionalschema.example/\"\n ],\n \"type\": \"AlumniCredential\",\n \"trustedIssuer\": [\n {\n \"required\": true,\n \"issuer\": \"did:key:z6MkjBWPPa1njEKygyr3LR3pRKkqv714vyTkfnUdP6ToFSH5\"\n }\n ]\n }\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all presentation templates", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all presentation templates on your tenant.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_FAIL" + }, + "response": [ + { + "name": "Presentation templates retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": [\n {\n \"id\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n ]\n }\n ]\n },\n {\n \"id\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n ]\n }\n ]\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve a presentation template", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieve an existing presentation template by its ID.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "Presentation template retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\"\n }\n },\n \"type\": {\n \"type\": \"string\",\n \"example\": \"AlumniCredential\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"required\",\n \"issuer\"\n ],\n \"properties\": {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\"\n }\n },\n \"type\": {\n \"type\": \"string\",\n \"example\": \"AlumniCredential\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"required\",\n \"issuer\"\n ],\n \"properties\": {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n ]\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete a presentation template", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing presentation template by its ID.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_FAIL" + }, + "response": [ + { + "name": "Presentation template deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update a presentation template", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"string\",\n \"name\": \"string\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n ]\n }\n ],\n \"id\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing presentation template by its ID.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_FAIL" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"domain\": \"string\",\n \"name\": \"string\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"minItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"minItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"minItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"minItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"minItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"minItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n ]\n }\n ],\n \"id\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "templates", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "string", + "description": "(Required) Presentation template ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\"\n }\n },\n \"type\": {\n \"type\": \"string\",\n \"example\": \"AlumniCredential\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"required\",\n \"issuer\"\n ],\n \"properties\": {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"@context\",\n \"type\",\n \"trustedIssuer\"\n ],\n \"properties\": {\n \"@context\": {\n \"type\": \"array\",\n \"description\": \"This is the JSON-LD schema used to expand the `example` in the `query`. Only matched credentials will be included in the presentation response. In case the credential uses a specific JSON-LD schema, you must add that schema into the `@context` array so that the credential could be matched against the presentation request.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\"\n }\n },\n \"type\": {\n \"type\": \"string\",\n \"example\": \"AlumniCredential\"\n },\n \"trustedIssuer\": {\n \"type\": \"array\",\n \"description\": \"This array is used to determine what credential issuers to accept in this verification workflow.\",\n \"maxItems\": 2,\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"required\",\n \"issuer\"\n ],\n \"properties\": {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n ]\n}" + } + ] + }, + { + "name": "Create a presentation request", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"challenge\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"templateId\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"did\": \"did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr\",\n \"callbackUrl\": \"https://your-website.com/api/callback\",\n \"expiresTime\": 1592955632103\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/requests", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "requests" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a short lived presentation request based on an existing presentation template. The request is returned in the form of a JWM message and must be [signed](#operation/signMessage) and sent to the holder via one of the following methods:\n- QR code.\n- Deeplink.\n- [Encrypted](#operation/encryptMessage) and [sent](#operation/sendMessage) as a wallet notification.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_START\n* PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_FAIL" + }, + "response": [ + { + "name": "Presentation request created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"challenge\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"templateId\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"did\": \"did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr\",\n \"callbackUrl\": \"https://your-website.com/api/callback\",\n \"expiresTime\": 1592955632103\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/requests", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "requests" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"id\": \"c74128a0-9949-11ea-9554-b5a630b3c119\",\n \"callbackUrl\": \"https://your-website.com/api/callback\",\n \"request\": {\n \"id\": \"c74128a0-9949-11ea-9554-b5a630b3c119\",\n \"type\": \"https://mattr.global/schemas/verifiable-presentation/request/QueryByExample\",\n \"from\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"created_time\": 1606709582907,\n \"expires_time\": 2594859115000,\n \"reply_url\": \"https://your-website.com/api/callback\",\n \"reply_to\": [\n \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\"\n ],\n \"body\": {\n \"id\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"domain\": \"tenant.vii.mattr.global\",\n \"name\": \"alumni_credential_request\",\n \"query\": [\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"QueryByExample\",\n \"credentialQuery\": [\n {\n \"type\": \"array\",\n \"maxItems\": 2,\n \"items\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"challenge\": \"e1b35ae0-9e0e-11ea-9bbf-a387b27c9e60\"\n }\n },\n \"didcommUri\": \"http://FTNClPwBxJVpmWufjQb.ulx9fhu4NS-A97M6,h9XyUjdWgKKGg+YjGcXBfz.WL6nGt4QVwWeaECRmQiO\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"challenge\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"templateId\": \"64e45290-9980-11ea-b872-f1bee5fb328f\",\n \"did\": \"did:key:z6Mkt7bFYc4V2HdAxwhMtaY6cgJckYXwhYdPLJCcnVqzrkpr\",\n \"callbackUrl\": \"https://your-website.com/api/callback\",\n \"expiresTime\": 1592955632103\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/requests", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "requests" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Verify a verifiable presentation", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"presentation\": {\n \"verifiableCredential\": [\n {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://www.w3.org/2018/credentials/examples/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n }\n ],\n \"id\": \"stri\",\n \"holder\": \"string\",\n \"proof\": [\n {\n \"type\": \"string\",\n \"created\": \"string\",\n \"challenge\": \"string\",\n \"domain\": \"string\",\n \"jws\": \"string\",\n \"proofPurpose\": \"string\",\n \"verificationMethod\": \"string\"\n }\n ]\n },\n \"challenge\": \"3182bdea-63d9-11ea-b6de-3b7c1404d57f\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Verifies a provided verifiable presentation that adheres to the [W3C Verifiable Credential Data Model](https://www.w3.org/TR/vc-data-model/#presentations):\n- Ensures the presentation conforms to the VC Data model.\n- For each `verifiableCredential` objects:\n - Issuer DID can be resolved.\n - JSON-LD context is valid for subject claims.\n - Proof is valid & the credential has not been tampered with.\n - Is not in a `revoked` status on a `RevocationList2020`.\n - The proof is valid for each subjectDID to prove ownership.\n - Valid proof exists for the presentation `holderDID`.\n\nThe request must include a `presentation` object that adheres to the [W3C Verifiable Credential Data Model](https://www.w3.org/TR/vc-data-model/#presentations).\n\nIf a `challenge` and/or `domain` is provided they are used for credential verification. Otherwise, the `challenge` and/or `domain` within the presentation proof is used instead.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_VERIFY_START\n* PRESENTATION_WEB_SEMANTIC_VERIFY_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_VERIFY_FAIL" + }, + "response": [ + { + "name": "Presentation verification completed", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"presentation\": {\n \"verifiableCredential\": [\n {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://www.w3.org/2018/credentials/examples/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n }\n ],\n \"id\": \"string\",\n \"holder\": \"string\",\n \"proof\": [\n {\n \"type\": \"string\",\n \"created\": \"string\",\n \"challenge\": \"string\",\n \"domain\": \"string\",\n \"jws\": \"string\",\n \"proofPurpose\": \"string\",\n \"verificationMethod\": \"strin\"\n }\n ]\n },\n \"challenge\": \"3182bdea-63d9-11ea-b6de-3b7c1404d57f\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verified\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"presentation\": {\n \"verifiableCredential\": [\n {\n \"@context\": [\n \"https://www.w3.org/2018/credentials/v1\",\n \"https://www.w3.org/2018/credentials/examples/v1\"\n ],\n \"type\": [\n \"VerifiableCredential\",\n \"AlumniCredential\"\n ],\n \"issuanceDate\": \"2020-05-02T12:06:29.156Z\",\n \"credentialSubject\": {\n \"givenName\": \"Jamie\",\n \"familyName\": \"Doe\",\n \"alumniOf\": \"Example University\"\n },\n \"proof\": {\n \"type\": \"Ed25519Signature2018\",\n \"created\": \"2020-05-02T12:06:29Z\",\n \"jws\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n \"proofPurpose\": \"assertionMethod\",\n \"verificationMethod\": \"did:web:organization.com\"\n },\n \"issuer\": {\n \"id\": \"did:web:organization.com\",\n \"name\": \"Example University\",\n \"logoUrl\": \"https://example.edu/img/logo.png\",\n \"iconUrl\": \"https://example.edu/img/icon.png\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"#B00AA0\",\n \"watermarkImageUrl\": \"https://example.edu/img/watermark.png\"\n },\n \"credentialStatus\": {\n \"id\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3#1\",\n \"type\": \"RevocationList2020Status\",\n \"revocationListIndex\": 1,\n \"revocationListCredential\": \"https://tenant.vii.mattr.global/v1/revocation-lists/cc641396-3750-43c8-b8b8-f30d74eb3fb3\"\n },\n \"name\": \"Alumni Credential\",\n \"description\": \"This credential shows that the person has attended the mentioned university.\"\n }\n ],\n \"id\": \"string\",\n \"holder\": \"string\",\n \"proof\": [\n {\n \"type\": \"string\",\n \"created\": \"string\",\n \"challenge\": \"string\",\n \"domain\": \"string\",\n \"jws\": \"string\",\n \"proofPurpose\": \"string\",\n \"verificationMethod\": \"strin\"\n }\n ]\n },\n \"challenge\": \"3182bdea-63d9-11ea-b6de-3b7c1404d57f\",\n \"domain\": \"example.com\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/verify", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v2", + "credentials", + "web-semantic", + "presentations", + "verify" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for verifying JSON credentials." + }, + { + "name": "OIDC bridge verification", + "item": [ + { + "name": "OIDC Verifier Auth", + "item": [ + { + "name": "Well Known OpenId Configuration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/.well-known/openid-configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + ".well-known", + "openid-configuration" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "The standard OpenID Connect Well Known configuration metadata endpoint.\n\nThis endpoint is unprotected, public facing and can be used by any party wishing to discover the OpenID Connect capabilities.\n" + }, + "response": [ + { + "name": "Returns OpenID configuration", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/.well-known/openid-configuration", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + ".well-known", + "openid-configuration" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"authorization_endpoint\": \"https://tenant.vii.mattr.global/ext/oidc/v1/issuers/983c0a86-204f-4431-9371-f5a22e506599/authorize\",\n \"claims_parameter_supported\": true,\n \"claims_supported\": [\n \"sub\",\n \"sid\",\n \"auth_time\",\n \"iss\"\n ],\n \"code_challenge_methods_supported\": [\n \"S256\"\n ],\n \"end_session_endpoint\": \"https://tenant.vii.mattr.global/ext/oidc/v1/issuers/983c0a86-204f-4431-9371-f5a22e506599/session/end\",\n \"grant_types_supported\": [\n \"implicit\",\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"id_token_signing_alg_values_supported\": [\n \"HS256\",\n \"ES256\"\n ],\n \"issuer\": \"https://tenant.vii.mattr.global\",\n \"jwks_uri\": \"https://tenant.vii.mattr.global/ext/oidc/v1/issuers/983c0a86-204f-4431-9371-f5a22e506599/jwks\",\n \"registration_endpoint\": \"https://tenant.vii.mattr.global/ext/oidc/v1/issuers/983c0a86-204f-4431-9371-f5a22e506599/clients\",\n \"request_object_signing_alg_values_supported\": [\n \"HS256\",\n \"RS256\",\n \"PS256\",\n \"ES256\",\n \"EdDSA\"\n ],\n \"request_parameter_supported\": true,\n \"request_uri_parameter_supported\": true,\n \"require_request_uri_registration\": true,\n \"response_modes_supported\": [\n \"form_post\",\n \"fragment\",\n \"query\"\n ],\n \"response_types_supported\": [\n \"code id_token\",\n \"code\",\n \"id_token\",\n \"none\"\n ],\n \"scopes_supported\": [\n \"openid\",\n \"offline_access\"\n ],\n \"subject_types_supported\": [\n \"public\"\n ],\n \"token_endpoint_auth_methods_supported\": [\n \"none\",\n \"client_secret_basic\",\n \"client_secret_jwt\",\n \"client_secret_post\",\n \"private_key_jwt\"\n ],\n \"token_endpoint_auth_signing_alg_values_supported\": [\n \"HS256\",\n \"RS256\",\n \"PS256\",\n \"ES256\",\n \"EdDSA\"\n ],\n \"token_endpoint\": \"https://tenant.vii.mattr.global/ext/oidc/v1/issuers/983c0a86-204f-4431-9371-f5a22e506599/token\",\n \"userinfo_endpoint\": \"https://tenant.vii.mattr.global/ext/oidc/v1/issuers/983c0a86-204f-4431-9371-f5a22e506599/me\",\n \"userinfo_signing_alg_values_supported\": [\n \"HS256\",\n \"ES256\"\n ],\n \"claim_types_supported\": [\n \"normal\"\n ]\n}" + } + ] + }, + { + "name": "Retrieve Token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/x-www-form-urlencoded" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_secret", + "value": "aYzQUXD0VtlNHhTnxt6cyJeMgLczIBm-AA87STG0narCG8P0iL78fAO7TcWjPBYKwpoZY7Sw8MWNwvqf5VVqFw" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "code", + "value": "shdT2ks5tg9b" + }, + { + "key": "redirect_uri", + "value": "https://my-client-rp.example.com" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "token" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "> OIDC Token endpoint\n\nThe OpenId Connect `/token` endpoint is used to obtain the `access_token` and `id_token` by presenting a valid authorization `code`\n\n### **Analytic events**\n* OIDC_VERIFIER_AUTH_START\n* OIDC_VERIFIER_AUTH_SUCCESS\n* OIDC_VERIFIER_AUTH_FAIL" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_secret", + "value": "aYzQUXD0VtlNHhTnxt6cyJeMgLczIBm-AA87STG0narCG8P0iL78fAO7TcWjPBYKwpoZY7Sw8MWNwvqf5VVqFw" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "code", + "value": "shdT2ks5tg9b" + }, + { + "key": "redirect_uri", + "value": "https://my-client-rp.example.com" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "token" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"access_token\": \"string\",\n \"token_type\": \"bearer\",\n \"refresh_token\": \"string\",\n \"expires_in\": 7735,\n \"id_token\": \"string\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "client_secret", + "value": "aYzQUXD0VtlNHhTnxt6cyJeMgLczIBm-AA87STG0narCG8P0iL78fAO7TcWjPBYKwpoZY7Sw8MWNwvqf5VVqFw" + }, + { + "key": "grant_type", + "value": "authorization_code" + }, + { + "key": "code", + "value": "shdT2ks5tg9b" + }, + { + "key": "redirect_uri", + "value": "https://my-client-rp.example.com" + } + ] + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "token" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for retrieving information required for OIDC bridge verification workflows." + }, + { + "name": "OIDC Verifiers", + "item": [ + { + "name": "Create an OIDC Verifier", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Creates a new OIDC Credential Verifier on the tenant.\n\nOnce created, this OIDC Verifier is publicly available on its `/.well-known/openid-configuration` path. The Authorization header is not required as it is intended for OIDC Client applications to resolve.\n\n### **Analytic events**\n* OIDC_VERIFIER_CREATE_START\n* OIDC_VERIFIER_CREATE_SUCCESS\n* OIDC_VERIFIER_CREATE_FAIL\n" + }, + "response": [ + { + "name": "OIDC Verifier created", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n },\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"id\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"includePresentation\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers" + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all OIDC Verifiers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all OIDC Verifiers on the tenant.\n\n### **Analytic events**\n* OIDC_VERIFIER_RETRIEVE_LIST_START\n* OIDC_VERIFIER_RETRIEVE_LIST_SUCCESS\n* OIDC_VERIFIER_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "OIDC Verifiers retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": {\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n },\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"id\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"includePresentation\": true\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an OIDC Verifier", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing OIDC Verifier by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_RETRIEVE_START\n* OIDC_VERIFIER_RETRIEVE_SUCCESS\n* OIDC_VERIFIER_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "OIDC Verifier retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n },\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"id\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"includePresentation\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an OIDC Verifier", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing OIDC Verifier by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_UPDATE_START\n* OIDC_VERIFIER_UPDATE_SUCCESS\n* OIDC_VERIFIER_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "OIDC Verifier updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n },\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"id\": \"41458e5a-9092-40b7-9a26-d4eb43c5792f\",\n \"includePresentation\": true\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"verifierDid\": \"did:key:z6MkrYVmyqSA93o4B1GwERM8kaQDMAUKAFV2TC3weQKeg9Gq\",\n \"presentationTemplateId\": \"364b6a1b-3600-4927-a6ac-4d66aa6bbac3\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"http://schema.org/alumniOf\",\n \"oidcClaim\": \"alumni_of\"\n }\n ],\n \"includePresentation\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an OIDC Verifier", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing OIDC Verifier by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_DELETE_START\n* OIDC_VERIFIER_DELETE_SUCCESS\n* OIDC_VERIFIER_DELETE_FAIL\n" + }, + "response": [ + { + "name": "OIDC Verifier deleted", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"BadRequest\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Invalid value\",\n \"param\": \"verifierId\",\n \"value\": \"abc\"\n }\n ]\n}" + }, + { + "name": "OIDC Verifier not found", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"NotFound\",\n \"message\": \"Validation Error\",\n \"details\": [\n {\n \"location\": \"params\",\n \"msg\": \"Resource Not Found\",\n \"param\": \"verifierId\",\n \"value\": \"a368cfb4-9537-4439-acc6-ce3cf2287eb7\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing OIDC Verifiers." + }, + { + "name": "OIDC Verifier Client", + "item": [ + { + "name": "Configure an OIDC Client", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Configures an OIDC Verifier Client on your tenant.\n\nIn order to verify a credential using an OpenID Connect Authorization Code Flow, you need to set up an OIDC Client application. This is the client that will engage with your configured OIDC Verifier to initiate the verification workflow.\nThere is a list of OIDC Client apps, also known as Relying Party Libraries, on the [OpenID website](https://openid.net/developers/certified/). Pick one which you feel comfortable with.\n\n> When dealing with personal identity information it is strongly recommended to follow the Authorization Code Flow which ensures sensitive data is transmitted via the `/token` endpoint back-channel.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_CREATE_START\n* OIDC_VERIFIER_CLIENT_CREATE_SUCCESS\n* OIDC_VERIFIER_CLIENT_CREATE_FAIL" + }, + "response": [ + { + "name": "OIDC Client configured", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"id\": \"da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d\",\n \"secret\": \"H2epdcmNJ46hXJo5opdzvhbZK9W2ZGPkQh.E\",\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve all OIDC Clients", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients" + ], + "query": [ + { + "key": "limit", + "value": "2", + "description": "Range size of returned list." + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "description": "Starting point for the list of entries." + } + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Returns a list of all OIDC Verifier Clients on the Tenant.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_START\n* OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_SUCCESS\n* OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_FAIL\n" + }, + "response": [ + { + "name": "OIDC Clients retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"nextCursor\": \"Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM\",\n \"data\": {\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"id\": \"da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d\",\n \"secret\": \"H2epdcmNJ46hXJo5opdzvhbZK9W2ZGPkQh.E\",\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n }\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients" + ], + "query": [ + { + "key": "limit", + "value": "2" + }, + { + "key": "cursor", + "value": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h" + } + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) Verifier ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + } + ] + }, + { + "name": "Retrieve an OIDC Client", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Retrieves an existing OIDC Verifier Client by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_RETRIEVE_START\n* OIDC_VERIFIER_CLIENT_RETRIEVE_SUCCESS\n* OIDC_VERIFIER_CLIENT_RETRIEVE_FAIL" + }, + "response": [ + { + "name": "OIDC Verifier Client retrieved", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"id\": \"da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d\",\n \"secret\": \"H2epdcmNJ46hXJo5opdzvhbZK9W2ZGPkQh.E\",\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Update an OIDC Client", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Updates an existing OIDC Verifier Client by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_UPDATE_START\n* OIDC_VERIFIER_CLIENT_UPDATE_SUCCESS\n* OIDC_VERIFIER_CLIENT_UPDATE_FAIL\n" + }, + "response": [ + { + "name": "OIDC Verifier Client updated", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"id\": \"da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d\",\n \"secret\": \"H2epdcmNJ46hXJo5opdzvhbZK9W2ZGPkQh.E\",\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"OIDC Client for the verifier\",\n \"redirectUris\": [\n \"https://example.com/callback\"\n ],\n \"responseTypes\": [\n \"code\"\n ],\n \"grantTypes\": [\n \"authorization_code\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_post\",\n \"idTokenSignedResponseAlg\": \"ES256\",\n \"applicationType\": \"web\",\n \"logoUri\": \"https://example.com/logo.png\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + }, + { + "name": "Delete an OIDC Client", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + }, + "description": "Deletes an existing OIDC Verifier Client by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_DELETE_START\n* OIDC_VERIFIER_CLIENT_DELETE_SUCCESS\n* OIDC_VERIFIER_CLIENT_DELETE_FAIL\n" + }, + "response": [ + { + "name": "OIDC Verifier Client deleted.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Bad Request. The request was malformed or missing required parameters.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n },\n {\n \"msg\": \"Invalid value\",\n \"value\": \"string\",\n \"param\": \"id\",\n \"location\": \"body\"\n }\n ]\n}" + }, + { + "name": "Not Found. The specified resource was not found.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "ext", + "oidc", + "v1", + "verifiers", + ":id", + "clients", + ":clientId" + ], + "variable": [ + { + "key": "id", + "value": "41458e5a-9092-40b7-9a26-d4eb43c5792f", + "description": "(Required) OIDC Verifier ID" + }, + { + "key": "clientId", + "value": "da9bb6e4-c9ae-4468-b6ac-72b90d6efd5d", + "description": "(Required) OIDC Verifier Client ID" + }, + { + "key": "tenantName", + "value": "{{tenantName}}", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "{{region}}", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n },\n {\n \"msg\": \"Invalid value\",\n \"param\": \"id\",\n \"location\": \"body\",\n \"value\": \"string\"\n }\n ]\n}" + } + ] + } + ], + "description": "Specifies paths and operations for managing OIDC Verifier Clients." + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "const tokenUrl = pm.environment.get('auth0Base') + '/oauth/token';", + "", + "const clientId = pm.environment.get('tenantClientId');", + "const clientSecret = pm.environment.get('tenantClientSecret');", + "", + "const echoPostRequest = {", + " url: tokenUrl,", + " method: 'POST',", + " header: 'Content-Type:application/json',", + " body: {", + " mode: 'application/json',", + " raw: JSON.stringify(", + " {", + " \tclient_id: clientId,", + " \tclient_secret: clientSecret,", + " \taudience: pm.environment.get('tenantAudience'),", + " \tgrant_type:'client_credentials'", + " })", + " }", + "};", + "", + "var getToken = true;", + "", + "if (!pm.environment.get('accessTokenExpiry') || ", + " !pm.environment.get('bearerToken')) {", + " console.log('Token or expiry date are missing')", + "} else if (pm.environment.get('accessTokenExpiry') <= (new Date()).getTime()) {", + " console.log('Token is expired')", + "} else {", + " getToken = false;", + " console.log('Token and expiry date are all good');", + "}", + "", + "if (getToken === true) {", + " pm.sendRequest(echoPostRequest, function (err, res) {", + " console.log(err ? err : res.json());", + " if (err === null) {", + " console.log('Saving the token and expiry date')", + " var responseJson = res.json();", + " pm.environment.set('bearerToken', responseJson.access_token)", + " ", + " var expiryDate = new Date();", + " expiryDate.setSeconds(expiryDate.getSeconds() + responseJson.expires_in);", + " pm.environment.set('accessTokenExpiry', expiryDate.getTime());", + " }", + " });", + "}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "tenantName", + "value": "example", + "description": "The tenant subdomain assigned when the tenant was established." + }, + { + "key": "region", + "value": "au01", + "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" + }, + { + "key": "baseUrl", + "value": "https://{{tenantName}}.vii.{{region}}.mattr.global" + }, + { + "key": "oauth-token-Url", + "value": "https://auth.au01.mattr.global" + } + ] +} \ No newline at end of file diff --git a/postman/platform-v9.0.0-postman-collection.json b/postman/platform-v9.0.0-postman-collection.json deleted file mode 100644 index 7d4ca85d..00000000 --- a/postman/platform-v9.0.0-postman-collection.json +++ /dev/null @@ -1,44828 +0,0 @@ -{ - "info": { - "_postman_id": "66df968a-8f07-42e9-96b0-364fa03bd223", - "name": "MATTR VII Platform API (v9.0.0)", - "description": "# Introduction\nThe MATTR VII API defines a set of capabilities that can be used to manage and interact with a MATTR VII tenant. This includes managing a Verifiable Credential across its lifecycle (issue-hold-verify) as well as various tenant administration and management tasks such as setting up a custom domain, creating identifiers and configuring issuance and verification workflows.\n\n# Getting Started with our APIs\nAs a MATTR VII user, you are provided with the following details, required for accessing and engaging with your MATTR VII tenant:\n\n``` json\n{\n \"audience\": \"YOUR_AUDIENCE_URL\",\n \"auth_url\": \"YOUR_AUTH_URL\",\n \"tenant_url\": \"YOUR_TENANT_URL\",\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\"\n}\n```\n\n1. Use the `auth_url`, `audience`, `client_id` and `client_secret` to [obtain an access token](https://learn.mattr.global/api-reference/latest/tag/Security#operation/authToken).\n2. To make a request to your tenant, suffix the `tenant_url` with the endpoint route and include the obtained access token as a header bearer token. For example:\n\n```\nGET https://{tenant_url}/v1/dids\n```\n\n# Pagination\nMost list operations in the API enable cursor pagination using the `cursor` and `limit` query parameters:\n\n**Example on [Retrieve List of Credentials](#operation/retrieveListCreds)**\n```\nGET https://{tenant-url}/core/v2/credentials\n?limit=100\n&cursor=Y3JlYXRlZEF0PTIwMjAtMTAtMDhUMjMlM0ExMyUzQTE3Ljg5NtZGUxZWEyNzQ4MWI4\n```\n\n* `limit`: determines how many entries are returned in that request, with a maximum value of 1000.\n* `cursor`: sets the location in the retrieved list to get the next batch of entries from. This is based on the returned `nextCursor`, found at the beginning of each returned range and identifies the last object in the list.\n\nRequesting an entry after the last list value will return an empty `data` object:\n\n``` json\n{\n\"data\": []\n}\n```\n\nNot providing a query parameter defaults the response to return the first range of entries with a `limit` of 100.\n\n# Authorization\nAccess to the API is granted by our authorization provider. Use the `auth_url`, `audience`, `client_id` and `client_secret` provided with your tenant details to [make a request](https://learn.mattr.global/api-reference/latest/tag/Security#operation/authToken) to receive a bearer token from the auth provider. This token must then be used as an `authorization` header for all requests to protected endpoints (this is required for the majority of operations).\n\n> The returned bearer token will only enable access to endpoints as per your client's defined role. Refer to [Access Control](#access-control) for more information.\n\n\n\n# Access control\n\nMATTR VII uses **Role-Based Access Control (RBAC)** to manage permissions and access within a tenant. Each role grants access to specific capabilities, ensuring that users or clients only have access to the functionalities they need. Below is a list of available roles and their descriptions:\n\n- Tenant admin: Has full access to all tenant capabilities. This role is\n assigned to the default client when a new tenant is created.\n- Issuer: Has access to capabilities required for issuing and managing\n credentials of different formats across different channels.\n- Verifier: Has access to capabilities required for verifying credentials\n of different formats across different channels.\n- DTS provider: Has access to capabilities required for managing a\n Digital trust service (DTS).\n- DTS consumer: Has access to capabilities required to consume DTS\n information from a tenant.\n- Auditor: Has read-only access to analytics data.\n\nEach restricted endpoint includes a Roles property that indicates what roles are required to access it.\n\n\nContact Support:\n Email: dev-support@mattr.global", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "28262321" - }, - "item": [ - { - "name": "General", - "item": [ - { - "name": "Analytics", - "item": [ - { - "name": "Retrieve events", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/analytics/events?limit=100&cursor=&dateFrom=&dateTo=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "analytics", "events"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - }, - { - "key": "dateFrom", - "value": "", - "description": "Query by event start date and time (inclusive), in ISO-8601 format." - }, - { - "key": "dateTo", - "value": "", - "description": "Query by event end date and time (inclusive), in ISO-8601 format." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of matching events from the tenant's event database. \n\nThe `categories` and `types` parameters filter based on an **OR** logic, whilst all other parameters use an \"AND\" logic. For example `(categories OR types) AND requestIds AND dateFrom`.\n\nRefer to the [Events registry](https://api-reference-sdk.mattr.global/event-registry/latest/index.html) for an inclusive list of events categories and types.\n" - }, - "response": [ - { - "name": "A list of events", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/analytics/events?limit=100&cursor=&dateFrom=&dateTo=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "analytics", "events"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "dateFrom", - "value": "" - }, - { - "key": "dateTo", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"timestamp\": \"\",\n \"category\": \"\",\n \"metadata\": \"\",\n \"data\": \"\",\n \"requestId\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"timestamp\": \"\",\n \"category\": \"\",\n \"metadata\": \"\",\n \"data\": \"\",\n \"requestId\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/analytics/events?limit=100&cursor=&dateFrom=&dateTo=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "analytics", "events"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "dateFrom", - "value": "" - }, - { - "key": "dateTo", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/analytics/events?limit=100&cursor=&dateFrom=&dateTo=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "analytics", "events"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "dateFrom", - "value": "" - }, - { - "key": "dateTo", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/analytics/events?limit=100&cursor=&dateFrom=&dateTo=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "analytics", "events"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "dateFrom", - "value": "" - }, - { - "key": "dateTo", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/analytics/events?limit=100&cursor=&dateFrom=&dateTo=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "analytics", "events"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "dateFrom", - "value": "" - }, - { - "key": "dateTo", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Specifies paths and operations for retrieving platform analytics data." - }, - { - "name": "Messaging", - "item": [ - { - "name": "Sign a message", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"didUrl\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/sign", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Accepts a message payload and signs it with a JWS (JSON Web Signature) using the a specific key from the DID (Decentralized Identifier) provided in the request.\n\n### **Analytic events**\n* MESSAGING_SIGN_START\n* MESSAGING_SIGN_SUCCESS\n* MESSAGING_SIGN_FAIL" - }, - "response": [ - { - "name": "Message signed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"didUrl\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/sign", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "\"\"" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"didUrl\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/sign", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Verify a message", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"jws\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Verifies the signature of a provided JWS (JSON Web Signature), validating that the payload has not been tampered with and verifying that the kid in the JWS header is the same as the `iss` value in the Request Object.\n\nOne use case for verifying a JWS with a DID is when the Mobile Wallet App sends a Request Object to an OpenID Provider as part of the Authorization Code Flow (as per https://openid.net/specs/openid-connect-core-1_0-final.html#RequestObject). The Request Object is wrapped in a JWS with a signature that is generated from the Subject DID on the mobile app. Therefore verifying the JWS proves that the mobile app has access to the private key of the Subject DID.\n\n### **Analytic events**\n* MESSAGING_VERIFY_START\n* MESSAGING_VERIFY_SUCCESS\n* MESSAGING_VERIFY_FAIL" - }, - "response": [ - { - "name": "Verification successful", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"jws\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"didUrl\": \"\",\n \"did\": \"\",\n \"verified\": \"\",\n \"payload\": \"\"\n}" - }, - { - "name": "Invalid JWS", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"jws\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Encrypt a message", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"senderDidUrl\": \"\",\n \"recipientDidUrls\": [\n \"\",\n \"\"\n ],\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/encrypt", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "encrypt"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Encrypts the provided payload using into a JWM (JSON Web Message) format.\n\n### **Analytic events**\n* MESSAGING_ENCRYPT_START\n* MESSAGING_ENCRYPT_SUCCESS\n* MESSAGING_ENCRYPT_FAIL\n" - }, - "response": [ - { - "name": "Message encrypted", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"senderDidUrl\": \"\",\n \"recipientDidUrls\": [\n \"\",\n \"\"\n ],\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/encrypt", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "encrypt"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"jwe\": {\n \"protected\": \"\",\n \"recipients\": [\n {\n \"encryption_key\": \"\",\n \"header\": {\n \"alg\": \"\",\n \"kid\": \"\",\n \"epk\": {\n \"kty\": \"\",\n \"crv\": \"\",\n \"x\": \"\"\n },\n \"skid\": \"\"\n }\n }\n ],\n \"ciphertext\": \"\",\n \"iv\": \"\",\n \"tag\": \"\"\n }\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"senderDidUrl\": \"\",\n \"recipientDidUrls\": [\n \"\",\n \"\"\n ],\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/encrypt", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "encrypt"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Decrypt a message", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"jwe\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/decrypt", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "decrypt"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Decrypts a provided message where the tenant manages the keys for the defined `recipientDidUrl`.\n\n### **Analytic events**\n* MESSAGING_DECRYPT_START\n* MESSAGING_DECRYPT_SUCCESS\n* MESSAGING_DECRYPT_FAIL" - }, - "response": [ - { - "name": "Message Decrypted", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"jwe\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/decrypt", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "decrypt"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"payload\": \"\",\n \"senderDidUrl\": \"\",\n \"senderPublicJwk\": \"\",\n \"recipientDidUrl\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"jwe\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/decrypt", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "decrypt"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Send a message", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"to\": \"\",\n \"message\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/send", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "send"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Sends an encrypted JWM (JSON Web Messaging) format message to a service endpoint defined in a public DID document.\n\n### **Analytic events**\n* MESSAGING_SEND_START\n* MESSAGING_SEND_SUCCESS\n* MESSAGING_SEND_FAIL" - }, - "response": [ - { - "name": "Message sent", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"to\": \"\",\n \"message\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/send", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "send"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"to\": \"\",\n \"message\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/send", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "send"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for signing, encrypting, decrypting and sending messages." - }, - { - "name": "Inboxes", - "item": [ - { - "name": "Create an inbox", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates an inbox that can register DIDs and then hold messages sent to those DIDs service points.\n\n### **Analytic events**\n* MESSAGING_INBOX_CREATE_START\n* MESSAGING_INBOX_CREATE_SUCCESS\n* MESSAGING_INBOX_CREATE_FAIL" - }, - "response": [ - { - "name": "Inbox created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "List inboxes", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all inboxes on the tenant.\n\n### **Analytic events**\n* MESSAGING_INBOX_RETRIEVE_LIST_START\n* MESSAGING_INBOX_RETRIEVE_LIST_SUCCESS\n* MESSAGING_INBOX_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "A list of inboxes", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve an inbox", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an inbox based on its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_RETRIEVE_START\n* MESSAGING_INBOX_RETRIEVE_SUCCESS\n* MESSAGING_INBOX_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Inbox returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update an inbox", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Update the inbox configurations" - }, - "response": [ - { - "name": "Inbox updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an inbox", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an inbox by providing its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_DELETE_START\n* MESSAGING_INBOX_DELETE_SUCCESS\n* MESSAGING_INBOX_DELETE_FAIL" - }, - "response": [ - { - "name": "Inbox deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Register DID with an inbox", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"did\": \"\",\n \"jwt\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id", "dids"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Register the provided DID to the requested inbox.\n\n> DID registration with inboxes is currently limited to `did:key`'\n\n### **Analytic events**\n* MESSAGING_INBOX_DID_REGISTER_START\n* MESSAGING_INBOX_DID_REGISTER_SUCCESS\n* MESSAGING_INBOX_DID_REGISTER_FAIL" - }, - "response": [ - { - "name": "DID registered with inbox", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"did\": \"\",\n \"jwt\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"did\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"did\": \"\",\n \"jwt\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"did\": \"\",\n \"jwt\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve inbox DIDs", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "messaging", "inboxes", ":id", "dids"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all the DIDs registered with the requested inbox.\n\n### **Analytic events**\n* MESSAGING_INBOX_DID_RETRIEVE_LIST_START\n* MESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESS\n* MESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "A list of inbox DIDs", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n \"\",\n \"\"\n ]\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Unregister DID with an inbox", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids/:did", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids", - ":did" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "did", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Unregisters a DID from the requested inbox.\n\n### **Analytic events**\n* MESSAGING_INBOX_DID_UNREGISTER_START\n* MESSAGING_INBOX_DID_UNREGISTER_SUCCESS\n* MESSAGING_INBOX_DID_UNREGISTER_FAIL" - }, - "response": [ - { - "name": "DID unregistered from inbox", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids/:did", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids", - ":did" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "did", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids/:did", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids", - ":did" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "did", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/dids/:did", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "dids", - ":did" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "did", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all messages", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieving all the messages from an inbox\n\n### **Analytic events**\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_START\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_SUCCESS\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "A list of inbox messages", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"name\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"inboxId\": \"\",\n \"payload\": \"\"\n },\n {\n \"name\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"inboxId\": \"\",\n \"payload\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a message", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a message from the requested inbox by providing its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_START\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_SUCCESS\n* MESSAGING_INBOX_MESSAGE_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "An inbox message", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"createdAt\": \"\",\n \"id\": \"\",\n \"inboxId\": \"\",\n \"payload\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a message", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes a message from the requested inbox by providing its ID.\n\n### **Analytic events**\n* MESSAGING_INBOX_MESSAGE_DELETE_START\n* MESSAGING_INBOX_MESSAGE_DELETE_SUCCESS\n* MESSAGING_INBOX_MESSAGE_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Message deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/messaging/inboxes/:id/messages/:messageid", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "messaging", - "inboxes", - ":id", - "messages", - ":messageid" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Requested inbox ID" - }, - { - "key": "messageid", - "value": "", - "description": "(Required) Requested message ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing inboxes." - } - ] - }, - { - "name": "Tenant configuration", - "item": [ - { - "name": "Security", - "item": [ - { - "name": "Create API Auth Token", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"audience\": \"\",\n \"grant_type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{oauth-token-Url}}/oauth/token", - "host": ["{{oauth-token-Url}}"], - "path": ["oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Authorization endpoint for gaining token used for API requests requiring `bearerAuth`.\n\nYou will be provided the required `client_id` and `client_secret` as part of onboarding.\n\n> The returned bearer token will only enable access to endpoints as per your client's defined role. Refer to [Access Control](https://learn.mattr.global/docs/platform-management/access-control) for more information." - }, - "response": [ - { - "name": "Successful response", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"audience\": \"\",\n \"grant_type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{oauth-token-Url}}/oauth/token", - "host": ["{{oauth-token-Url}}"], - "path": ["oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"\"\n}" - }, - { - "name": "Unauthorized", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"audience\": \"\",\n \"grant_type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{oauth-token-Url}}/oauth/token", - "host": ["{{oauth-token-Url}}"], - "path": ["oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"error\": \"\",\n \"error_description\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for accessing protected endpoints." - }, - { - "name": "Custom Domain", - "item": [ - { - "name": "Configure custom domain", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a custom domain configuration on your tenant. You can configure a custom domain for a specific MATTR VII tenant to represent your brand and instil trust with your end-users. Any MATTR VII tenant can only have one custom domain. Refer to our [docs](https://learn.mattr.global/docs/capabilities/platform-management/custom) for more information.\n\n> Custom domains are only available as part of our paid plans, and trial accounts do not include ongoing access to custom domains. The APIs are available for you to trial the feature, but they may be deactivated unless you switch to a paid plan.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_CREATE_START\n* CONFIG_CUSTOM_DOMAIN_CREATE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_CREATE_FAIL\n" - }, - "response": [ - { - "name": "Custom domain created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\",\n \"verificationToken\": \"\",\n \"isVerified\": \"\",\n \"verifiedAt\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve custom domain", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns your tenant's custom domain configuration and its verification status.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_RETRIEVE_START\n* CONFIG_CUSTOM_DOMAIN_RETRIEVE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Custom domain returned", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\",\n \"verificationToken\": \"\",\n \"isVerified\": \"\",\n \"verifiedAt\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete custom domain", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes the custom domain configuration on your tenant.\n\n> Deleting your custom domain configuration breaks the linkage with any credentials issued under the custom domain. These credentials will no longer be valid.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_DELETE_START\n* CONFIG_CUSTOM_DOMAIN_DELETE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_DELETE_FAIL" - }, - "response": [ - { - "name": "Custom domain deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update custom domain", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates the custom domain configuration.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_UPDATE_START\n* CONFIG_CUSTOM_DOMAIN_UPDATE_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_UPDATE_FAIL" - }, - "response": [ - { - "name": "Custom Domain updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\",\n \"verificationToken\": \"\",\n \"isVerified\": \"\",\n \"verifiedAt\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"domain\": \"\",\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Verify custom domain", - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Verifies that you have control of the configured custom domain by examining its TXT record.\n\n> Your custom domain will not be active until you verify it. Refer to [Verify domain ownership](https://learn.mattr.global/docs/capabilities/platform-management/custom#verify-domain-ownership) for more information.\n\n### **Analytic events**\n* CONFIG_CUSTOM_DOMAIN_VERIFY_START\n* CONFIG_CUSTOM_DOMAIN_VERIFY_SUCCESS\n* CONFIG_CUSTOM_DOMAIN_VERIFY_FAIL" - }, - "response": [ - { - "name": "Custom domain verified", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/config/domain/verify", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "config", "domain", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing custom domains." - }, - { - "name": "DIDs", - "item": [ - { - "name": "Well known DID configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/.well-known/did-configuration", - "host": ["{{baseUrl}}"], - "path": [".well-known", "did-configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of Decentralized Identifier (DID) Configuration entries from the tenant. These are automatically created for **all** DIDS created on a tenant so that they can be used by any party aiming to establish and verify the domain-DID linkage by exposing cryptographic proofs. Thus, this endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party. Refer to [Well Known DID Configuration](https://identity.foundation/.well-known/resources/did-configuration) on the Decentralized Identity Foundation website for more information.\n" - }, - "response": [ - { - "name": "List of DID Configuration entries", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/.well-known/did-configuration", - "host": ["{{baseUrl}}"], - "path": [".well-known", "did-configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"entries\": [\n {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create a DID", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"method\": \"\",\n \"options\": {\n \"keyType\": \"\",\n \"url\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/dids", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Takes a supported [DID method](https://learn.mattr.global/docs/formats/json/dids#methods) and returns a new DID with its generated keys and required information. This endpoint also registers the DID Document when applicable.\n\nMATTR VII currently supports creating DIDs of the following methods:\n- **did:key**: The most basic type of DID. The public key forms the DID and has no further data associated with it.\n- **did:web**: This type of DID requires hosting the DID document on a publicly accessible domain in order to make the document and its contents available.\n\n### **Analytic events**\n* DID_CREATE_START\n* DID_CREATE_SUCCESS\n* DID_CREATE_FAIL" - }, - "response": [ - { - "name": "DID document created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"method\": \"\",\n \"options\": {\n \"keyType\": \"\",\n \"url\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/dids", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"registrationStatus\": \"\",\n \"did\": \"\",\n \"metadata\": {\n \"keys\": [\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n },\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n }\n ],\n \"registered\": \"\",\n \"initialDidDocument\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"method\": \"\",\n \"options\": {\n \"keyType\": \"\",\n \"url\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/dids", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a list of DIDs", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all DIDs (Decentralized Identifiers) managed by the tenant and their associated meta-data.\n\n### **Analytic events**\n* DID_RETRIEVE_LIST_START\n* DID_RETRIEVE_LIST_SUCCESS\n* DID_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "A list of DIDs", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"did\": \"\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n },\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n }\n ],\n \"registered\": \"\",\n \"initialDidDocument\": \"\"\n }\n },\n {\n \"did\": \"\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n },\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n }\n ],\n \"registered\": \"\",\n \"initialDidDocument\": \"\"\n }\n }\n ]\n}" - } - ] - }, - { - "name": "Resolve a DID", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a DID and its metadata from the tenant by its URI. This may involve a network call depending on the method involved:\n- For did:key the public key is encapsulated in the DID URI itself.\n- For did:web it must be resolved by accessing the `/.well-known/did.json` path on its domain.\n\n### **Analytic events**\n* DID_RETRIEVE_START\n* DID_RETRIEVE_SUCCESS\n* DID_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "A DID Document and its meta-data", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"did\": \"\",\n \"registrationStatus\": \"\",\n \"localMetadata\": {\n \"keys\": [\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n },\n {\n \"kmsKeyId\": \"\",\n \"didDocumentKeyId\": \"\"\n }\n ],\n \"registered\": \"\",\n \"initialDidDocument\": \"\"\n }\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a DID", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes a DID and all associated metadata by providing its URI. This includes all the removal of all associated private keys from the Key Management System (KMS).\n> For `did:web` you will need to manually remove the `did.json` from your hosted domain.\n\n### **Analytic events**\n* DID_DELETE_START\n* DID_DELETE_SUCCESS\n* DID_DELETE_FAIL" - }, - "response": [ - { - "name": "DID successfully deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/dids/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "dids", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) DID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing DIDs." - }, - { - "name": "IACA", - "item": [ - { - "name": "Create an IACA", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"commonName\": \"{tenantDomain} IACA\",\n \"country\": \"\",\n \"notBefore\": \"\",\n \"notAfter\": \"\",\n \"active\": true,\n \"stateOrProvinceName\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new IACA that can be used to sign new Document Signer Certificates (DSCs).\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_CREATE_START\n* MOBILE_CREDENTIAL_IACA_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_IACA_CREATE_FAIL" - }, - "response": [ - { - "name": "IACA created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"commonName\": \"{tenantDomain} IACA\",\n \"country\": \"\",\n \"notBefore\": \"\",\n \"notAfter\": \"\",\n \"active\": true,\n \"stateOrProvinceName\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"active\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"{tenantDomain} IACA\",\n \"stateOrProvinceName\": \"\"\n },\n \"publicKeyJwk\": \"\",\n \"certificateFingerprint\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"commonName\": \"{tenantDomain} IACA\",\n \"country\": \"\",\n \"notBefore\": \"\",\n \"notAfter\": \"\",\n \"active\": true,\n \"stateOrProvinceName\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all IACAs", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all existing IACAs from the tenant.\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "IACAs Retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"active\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"{tenantDomain} IACA\",\n \"stateOrProvinceName\": \"\"\n },\n \"publicKeyJwk\": \"\",\n \"certificateFingerprint\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"{tenantDomain} IACA\",\n \"stateOrProvinceName\": \"\"\n },\n \"publicKeyJwk\": \"\",\n \"certificateFingerprint\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve an IACA", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas", ":iacaId"], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing IACA by providing its ID.\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_START\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_IACA_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "IACA retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"active\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"{tenantDomain} IACA\",\n \"stateOrProvinceName\": \"\"\n },\n \"publicKeyJwk\": \"\",\n \"certificateFingerprint\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update IACA", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas", ":iacaId"], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Update the status of an IACA. Only active IACAs can be used for signing mDocs.\n\nCreating an IACA with `active` set to `false` enables distributing the IACA's PEM to relying parties in advance, before it is being used to sign mDocs.\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_UPDATE_START\n* MOBILE_CREDENTIAL_IACA_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_IACA_UPDATE_FAIL" - }, - "response": [ - { - "name": "IACA updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"active\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"{tenantDomain} IACA\",\n \"stateOrProvinceName\": \"\"\n },\n \"publicKeyJwk\": \"\",\n \"certificateFingerprint\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an IACA", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "iacas", ":iacaId"], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing IACA by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_IACA_DELETE_START\n* MOBILE_CREDENTIAL_IACA_DELETE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_IACA_DELETE_LIST_FAIL" - }, - "response": [ - { - "name": "IACA deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/iacas/:iacaId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "iacas", - ":iacaId" - ], - "variable": [ - { - "key": "iacaId", - "value": "", - "description": "(Required) IACA ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing IACAs." - }, - { - "name": "Webhooks", - "item": [ - { - "name": "Create Webhook", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new webhook for this tenant.\n\n### **Analytic events**\n* WEBHOOK_CREATE_START\n* WEBHOOK_CREATE_SUCCESS\n* WEBHOOK_CREATE_FAIL\n" - }, - "response": [ - { - "name": "Webhook created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": false\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Webhooks", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of webhooks configured on the tenant.\n\n### **Analytic events**\n* WEBHOOK_RETRIEVE_LIST_START\n* WEBHOOK_RETRIEVE_LIST_SUCCESS\n* WEBHOOK_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Webhooks retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": false\n },\n {\n \"id\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": false\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve Webhook", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) The requested Webhook ID." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve a specific Webhook by providing its ID.\n\n### **Analytic events**\n* WEBHOOK_RETRIEVE_START\n* WEBHOOK_RETRIEVE_SUCCESS\n* WEBHOOK_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Webhook retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) The requested Webhook ID." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": false\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) The requested Webhook ID." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update Webhook", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing Webhook by providing its ID.\n\n### **Analytic events**\n* WEBHOOK_UPDATE_START\n* WEBHOOK_UPDATE_SUCCESS\n* WEBHOOK_UPDATE_FAIL" - }, - "response": [ - { - "name": "Webhook updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": false\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"events\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"disabled\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete Webhook", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes a Webhook by providing its ID.\n\n### **Analytic events**\n* WEBHOOK_DELETE_START\n* WEBHOOK_DELETE_SUCCESS\n* WEBHOOK_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Webhook deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Webhook ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve Webhook JWKs", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/jwks", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", "jwks"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of Webhook JWKs (JSON Web Keys) from the tenant. These keys can be used to verify the HTTP signature and validate the integrity and authorship of generated Webhooks. This endpoint does not require authentication and is publicly available by design.\n" - }, - "response": [ - { - "name": "Webhook JWKs retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/webhooks/jwks", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "webhooks", "jwks"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"keys\": [\n {\n \"kty\": \"\",\n \"crv\": \"\",\n \"x\": \"\",\n \"use\": \"\",\n \"kid\": \"\"\n },\n {\n \"kty\": \"\",\n \"crv\": \"\",\n \"x\": \"\",\n \"use\": \"\",\n \"kid\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Webhooks." - } - ] - }, - { - "name": "Ecosystem operations", - "item": [ - { - "name": "Ecosystems", - "item": [ - { - "name": "Retrieve all ecosystems", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of ecosystems.\n### **Analytic events**\n* ECOSYSTEM_RETRIEVE_LIST_START\n* ECOSYSTEM_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Ecosystems retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"type\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n }\n }\n ]\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create ecosystem", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates an ecosystem.\n### **Analytic events**\n* ECOSYSTEM_CREATE_START\n* ECOSYSTEM_CREATE_SUCCESS\n* ECOSYSTEM_CREATE_FAIL" - }, - "response": [ - { - "name": "Ecosystem created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Sync ecosystem", - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/sync", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "sync"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Synchronizes all configured consumptions and integrations by retrieving the most recent trust information.\n### **Analytic events**\n* ECOSYSTEM_TENANT_SYNC_ALL_START\n* ECOSYSTEM_TENANT_SYNC_ALL_SUCCESS\n* ECOSYSTEM_TENANT_SYNC_ALL_FAIL" - }, - "response": [ - { - "name": "Ecosystem sync request accepted.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/sync", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "sync"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Accepted", - "code": 202, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"tenantConfiguration\": {\n \"ecosystems\": [\n {\n \"url\": \"\"\n },\n {\n \"url\": \"\"\n }\n ]\n },\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/sync", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "sync"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve ecosystem", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_RETRIEVE_START\n* ECOSYSTEM_RETRIEVE_SUCCESS\n* ECOSYSTEM_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Ecosystem retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update ecosystem", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_UPDATE_START\n* ECOSYSTEM_UPDATE_SUCCESS\n* ECOSYSTEM_UPDATE_FAIL" - }, - "response": [ - { - "name": "Ecosystem updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\",\n \"integrationResult\": {\n \"success\": \"\",\n \"lastSyncedAt\": \"\",\n \"lastModifiedAt\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"integrations\": [\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n },\n {\n \"format\": \"\",\n \"url\": \"\",\n \"enabled\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Delete ecosystem", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_DELETE_START\n* ECOSYSTEM_DELETE_SUCCESS\n* ECOSYSTEM_DELETE_FAIL" - }, - "response": [ - { - "name": "Ecosystem deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Specifies paths and operations for managing ecosystems." - }, - { - "name": "Participants", - "item": [ - { - "name": "Retrieve participants", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "participants"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of participants from the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_START\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Participants retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Create participant", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "participants"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_CREATE_START\n* ECOSYSTEM_PARTICIPANT_CREATE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_CREATE_FAIL" - }, - "response": [ - { - "name": "Participant created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Retrieve participant", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a participant from the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_START\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Participant retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update participant", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates a participant in the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_UPDATE_START\n* ECOSYSTEM_PARTICIPANT_UPDATE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_UPDATE_FAIL" - }, - "response": [ - { - "name": "Participant updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Delete participant", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes a participant in the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_PARTICIPANT_DELETE_START\n* ECOSYSTEM_PARTICIPANT_DELETE_SUCCESS\n* ECOSYSTEM_PARTICIPANT_DELETE_FAIL" - }, - "response": [ - { - "name": "Participant deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing ecosystem participants." - }, - { - "name": "Credential types", - "item": [ - { - "name": "Create credential type", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "credentials"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new credential type in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_CREATE_START\n* ECOSYSTEM_CREDENTIAL_CREATE_SUCCESS\n* ECOSYSTEM_CREDENTIAL_CREATE_FAIL" - }, - "response": [ - { - "name": "Credential type created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Retrieve credential types", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "credentials"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of credential types from the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_START\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_SUCCESS\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Credential types retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve credential type", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a credential type from the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_START\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_SUCCESS\n* ECOSYSTEM_CREDENTIAL_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Credential type retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete credential type", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes a credential type from the requested ecosystem by its ID.\n### **Analytic events**\n* ECOSYSTEM_CREDENTIAL_DELETE_START\n* ECOSYSTEM_CREDENTIAL_DELETE_SUCCESS\n* ECOSYSTEM_CREDENTIAL_DELETE_FAIL" - }, - "response": [ - { - "name": "Credential type deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing ecosystem credential types." - }, - { - "name": "Policy", - "item": [ - { - "name": "Publish policy", - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "policies"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Publish a new version of the ecosystem policy. Only active and currently valid participants and IACA certificates are included in the policy.\n### **Analytic events**\n* ECOSYSTEM_POLICY_CREATE_START\n* ECOSYSTEM_POLICY_CREATE_SUCCESS\n* ECOSYSTEM_POLICY_CREATE_FAIL" - }, - "response": [ - { - "name": "Ecosystem policy published", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "policies"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"policyPublishedAt\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "policies"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "policies"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "policies"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Retrieve latest ecosystem policy", - "request": { - "method": "GET", - "header": [ - { - "key": "If-None-Match", - "value": "", - "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." - }, - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "policies", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an ecosystem policy by providing the ecosystem ID.\n### **Analytic events**\n* ECOSYSTEM_POLICY_RETRIEVE_LATEST_START\n* ECOSYSTEM_POLICY_RETRIEVE_LATEST_SUCCESS\n* ECOSYSTEM_POLICY_RETRIEVE_LATEST_FAIL" - }, - "response": [ - { - "name": "Latest ecosystem policy retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "If-None-Match", - "value": "", - "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." - }, - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "policies", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "ETag", - "value": "", - "description": "An Entity Tag (ETag) is a unique identifier assigned to a specific version of a resource. It allows clients to check if a resource has been modified since it was last retrieved." - }, - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"policyModifiedAt\": \"\",\n \"policyPublishedAt\": \"\",\n \"credentials\": {\n \"599bf148-d711-405a-a20b-9c8a87ac8850\": {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n }\n },\n \"participants\": {\n \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\": {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\"\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ],\n \"issuerAllowedCredentials\": [\n \"\",\n \"\"\n ],\n \"verifierAllowedCredentials\": [\n \"\",\n \"\"\n ]\n }\n }\n}" - }, - { - "name": "Not Modified. The resource has not been modified since the last request.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "If-None-Match", - "value": "", - "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." - }, - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "policies", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Modified", - "code": 304, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "If-None-Match", - "value": "", - "description": "The If-None-Match parameter enables caching. Specify the ETag of the latest retrieved policy version, so that the policy is only retrieved if it had changed since." - }, - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/policies/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "policies", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve ecosystem policy preview", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/preview", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "preview"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an ecosystem policy preview by providing the Ecosystem's ID. A policy preview includes all the participants and credential types created in the ecosystem, excluding any participants with expired or inactive IACAs.\n\n### **Analytic events**\n* ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_START\n* ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_SUCCESS\n* ECOSYSTEM_POLICY_PREVIEW_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Ecosystem policy preview retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/preview", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "preview"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"policyModifiedAt\": \"\",\n \"credentials\": {\n \"599bf148-d711-405a-a20b-9c8a87ac8850\": {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n }\n },\n \"participants\": {\n \"a24e391a-c27f-4b6e-9805-1ee7e03f3c58\": {\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"name\": \"\",\n \"identifiers\": {\n \"web-semantic\": \"\",\n \"compact-semantic\": \"\",\n \"compact\": \"\",\n \"mobile\": [\n {\n \"certificatePem\": \"\",\n \"status\": \"\",\n \"validationResult\": {\n \"validated\": \"\",\n \"failReasons\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n }\n ]\n },\n \"isIssuer\": false,\n \"isVerifier\": false,\n \"isIssuerConstrained\": true,\n \"isVerifierConstrained\": true,\n \"status\": \"Inactive\",\n \"country\": \"\",\n \"stateOrProvince\": \"\",\n \"contacts\": [\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n },\n {\n \"phoneNumber\": \"\",\n \"address\": \"\"\n }\n ],\n \"issuerAllowedCredentials\": [\n \"\",\n \"\"\n ],\n \"verifierAllowedCredentials\": [\n \"\",\n \"\"\n ]\n }\n }\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept-Encoding", - "value": "", - "description": "Use the Accept-Encoding header to specify the supported content encodings." - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/preview", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "preview"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for publishing and retrieving an ecosystem policy." - }, - { - "name": "Issuer assignment", - "item": [ - { - "name": "Create issuer assignment", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Assigns a credential type to the requested participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_ISSUER_POLICY_CREATE_START\n* ECOSYSTEM_ISSUER_POLICY_CREATE_SUCCESS\n* ECOSYSTEM_ISSUER_POLICY_CREATE_FAIL" - }, - "response": [ - { - "name": "Issuer policy created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Delete issuer assignment", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Removes a credential type to the requested participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_ISSUER_POLICY_DELETE_START\n* ECOSYSTEM_ISSUER_POLICY_DELETE_SUCCESS\n* ECOSYSTEM_ISSUER_POLICY_DELETE_FAIL" - }, - "response": [ - { - "name": "Issuer policy deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/issuer/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "issuer", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Specifies paths and operations for assigning credential types to issuers." - }, - { - "name": "Verifier assignment", - "item": [ - { - "name": "Create verifier assignment", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Assigns a credential type to the requested participant in the requested ecosystem.\n### **Analytic events**\n* ECOSYSTEM_VERIFIER_POLICY_CREATE_START\n* ECOSYSTEM_VERIFIER_POLICY_CREATE_SUCCESS\n* ECOSYSTEM_VERIFIER_POLICY_CREATE_FAIL" - }, - "response": [ - { - "name": "Verifier policy created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"ecosystemId\": \"\",\n \"profile\": \"\",\n \"type\": \"\",\n \"name\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentialId\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Delete verifier assignment", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Removes a credential type from the requested participant in the requested ecosystem..\n### **Analytic events**\n* ECOSYSTEM_VERIFIER_POLICY_DELETE_START\n* ECOSYSTEM_VERIFIER_POLICY_DELETE_SUCCESS\n* ECOSYSTEM_VERIFIER_POLICY_DELETE_FAIL" - }, - "response": [ - { - "name": "Verifier policy deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/participants/:participantId/verifier/credentials/:credentialId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "participants", - ":participantId", - "verifier", - "credentials", - ":credentialId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "participantId", - "value": "", - "description": "(Required) The UUID of the participant" - }, - { - "key": "credentialId", - "value": "", - "description": "(Required) The UUID of the credential" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Specifies paths and operations for assigning credential types to verifiers." - }, - { - "name": "VICAL Configuration", - "item": [ - { - "name": "Update VICAL configuration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"vicalProvider\": \"\",\n \"vicalProviderFullName\": \"\",\n \"certificateCountry\": \"\",\n \"certificateCommonName\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Update the VICAL configuration for the requested ecosystem" - }, - "response": [ - { - "name": "VICAL configuration updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"vicalProvider\": \"\",\n \"vicalProviderFullName\": \"\",\n \"certificateCountry\": \"\",\n \"certificateCommonName\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"vicalProvider\": \"\",\n \"vicalProviderFullName\": \"\",\n \"certificateCountry\": \"\",\n \"certificateCommonName\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"vicalProvider\": \"\",\n \"vicalProviderFullName\": \"\",\n \"certificateCountry\": \"\",\n \"certificateCommonName\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve VICAL configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve the VICAL configuration from the requested ecosystem" - }, - "response": [ - { - "name": "VICAL configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"vicalProvider\": \"\",\n \"vicalProviderFullName\": \"\",\n \"certificateCountry\": \"\",\n \"certificateCommonName\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete VICAL configuration", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Delete the VICAL configuration for the requested ecosystem" - }, - "response": [ - { - "name": "VICAL configuration deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/configuration", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "configuration" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing VICAL configuration." - }, - { - "name": "VICAL Certificates", - "item": [ - { - "name": "Retrieve VICAL root CA certificate", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/certificates/ca/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "certificates", - "ca", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves the latest VICAL root ca certificate. This can be used by relying parties to verify the signed VICAL." - }, - "response": [ - { - "name": "VICAL root CA certificate retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/certificates/ca/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "certificates", - "ca", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/certificates/ca/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "certificates", - "ca", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve VICAL root CA certificate revocation list", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/certificates/ca/:caCertificateId/crl", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "certificates", - "ca", - ":caCertificateId", - "crl" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "caCertificateId", - "value": "", - "description": "(Required) Unique identifier of the VICAL root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves revocation list for a given VICAL root CA certificate." - }, - "response": [ - { - "name": "Revocation list retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/certificates/ca/:caCertificateId/crl", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "certificates", - "ca", - ":caCertificateId", - "crl" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "caCertificateId", - "value": "", - "description": "(Required) Unique identifier of the VICAL root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/certificates/ca/:caCertificateId/crl", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "certificates", - "ca", - ":caCertificateId", - "crl" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "caCertificateId", - "value": "", - "description": "(Required) Unique identifier of the VICAL root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing VICAL certificates." - }, - { - "name": "VICAL", - "item": [ - { - "name": "Create VICAL", - "request": { - "method": "POST", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "vicals"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a Verified Issuer Certificate Authority List (VICAL) based on the policy of the requested ecosystem. Refer to VICAL ot learn more about the [VICAL](https://learn.mattr.global/docs/digital-trust-service/vical) purpose and data structure." - }, - "response": [ - { - "name": "VICAL created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "vicals"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"vicalIssueID\": \"\",\n \"date\": \"\"\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", ":ecosystemId", "vicals"], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Retrieve all VICALs", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all VICALs available in the requested ecosystem." - }, - "response": [ - { - "name": "VICALs retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"date\": \"\",\n \"filename\": \"\",\n \"vicalIssueID\": \"\"\n },\n {\n \"date\": \"\",\n \"filename\": \"\",\n \"vicalIssueID\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve latest VICAL", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/cbor" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves the latest VICAL from the requested ecosystem." - }, - "response": [ - { - "name": "VICAL retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/cbor" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Disposition", - "value": "", - "description": "Indicates file attachment" - }, - { - "key": "Content-Length", - "value": "", - "description": "The size of the file in bytes" - }, - { - "key": "Content-Type", - "value": "application/cbor" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/latest", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - "latest" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve specific VICAL", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/cbor" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/:vicalIssueId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - ":vicalIssueId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "vicalIssueId", - "value": "", - "description": "(Required) Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a specific VICAL from the requested ecosystem by providing the VICAL version identifier." - }, - "response": [ - { - "name": "VICAL retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/cbor" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/:vicalIssueId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - ":vicalIssueId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "vicalIssueId", - "value": "", - "description": "(Required) Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Disposition", - "value": "", - "description": "Indicates file attachment" - }, - { - "key": "Content-Length", - "value": "", - "description": "The size of the file in bytes" - }, - { - "key": "Content-Type", - "value": "application/cbor" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/:ecosystemId/vicals/public/:vicalIssueId", - "host": ["{{baseUrl}}"], - "path": [ - "v1", - "ecosystems", - ":ecosystemId", - "vicals", - "public", - ":vicalIssueId" - ], - "variable": [ - { - "key": "ecosystemId", - "value": "", - "description": "(Required) The UUID of the ecosystem" - }, - { - "key": "vicalIssueId", - "value": "", - "description": "(Required) Unique identifier of a specific VICAL version. This numeric value is continuously increased whenever a VICAL is created." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for publishing and retrieving an ecosystem policy as a VICAL." - }, - { - "name": "Validation", - "item": [ - { - "name": "Validate issuer", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "issuer-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Validates that an issuer is allowed to issue a specific credential format according to the ecosystem policy.\n\n### **Analytics events**\n* ECOSYSTEM_VALIDATE_PARTICIPANT_START\n* ECOSYSTEM_VALIDATE_PARTICIPANT_SUCCESS\n* ECOSYSTEM_VALIDATE_PARTICIPANT_FAIL\n" - }, - "response": [ - { - "name": "Validation completed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "issuer-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"validated\": \"\",\n \"policyVersion\": \"\",\n \"identifier\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "issuer-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/issuer-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "issuer-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Validate verifier", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "verifier-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Validates that a verifier is allowed to verify a specific credential format according to the ecosystem policy.\n\n### **Analytics events**\n* ECOSYSTEM_VALIDATE_PARTICIPANT_START\n* ECOSYSTEM_VALIDATE_PARTICIPANT_SUCCESS\n* ECOSYSTEM_VALIDATE_PARTICIPANT_FAIL\n" - }, - "response": [ - { - "name": "Validation completed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "verifier-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"validated\": \"\",\n \"policyVersion\": \"\",\n \"identifier\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "verifier-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"profile\": \"\",\n \"identifier\": \"\",\n \"type\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v1/ecosystems/verifier-validation", - "host": ["{{baseUrl}}"], - "path": ["v1", "ecosystems", "verifier-validation"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ] - } - ] - }, - { - "name": "Direct credential issuance", - "item": [ - { - "name": "CWT credentials issuance", - "item": [ - { - "name": "Sign a CWT credential", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"iss\": \"\",\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"type\": \"\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a signed CWT credential generated from a provided valid payload.\n\nThe payload can include any number of custom claims, as CWT credentials do not comply with any specific standard or specification.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SIGN_START\n* CREDENTIAL_COMPACT_SIGN_SUCCESS\n* CREDENTIAL_COMPACT_SIGN_FAIL" - }, - "response": [ - { - "name": "CWT credential signed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"iss\": \"\",\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"type\": \"\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"encoded\": \"\",\n \"decoded\": {\n \"iss\": \"\",\n \"jti\": \"\",\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"type\": \"\",\n \"status\": {\n \"url\": \"\",\n \"index\": \"\"\n }\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"iss\": \"\",\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"type\": \"\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Format a CWT credential as a QR code", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "image/png" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": \"\",\n \"width\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/qrcode", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "qrcode"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a QR code representation of a CWT credential from a provided encoded string representation of that credential.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_QRCODE_CREATE_START\n* CREDENTIAL_COMPACT_QRCODE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_QRCODE_CREATE_FAIL" - }, - "response": [ - { - "name": "QR code generated", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "image/png" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": \"\",\n \"width\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/qrcode", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "qrcode"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "image/png" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": \"\",\n \"width\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/qrcode", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "qrcode"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Format a CWT credential as a PDF", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/pdf" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a PDF representation of a provided CWT credential based on an existing PDF template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_CREATE_START\n* CREDENTIAL_COMPACT_PDF_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_CREATE_FAIL" - }, - "response": [ - { - "name": "PDF created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/pdf" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/pdf" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Format a CWT credential as an Apple Pass", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/vnd.apple.pkpass" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns an Apple Pass representation of a provided CWT credential based on an existing Apple Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_CREATE_FAIL" - }, - "response": [ - { - "name": "Apple Pass created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/vnd.apple.pkpass" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.apple.pkpass" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Format a CWT credential as a Google Pass", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_CREATE_FAIL" - }, - "response": [ - { - "name": "Google Pass created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"redirectTo\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for issuing CWT credentials." - }, - { - "name": "Semantic CWT credentials issuance", - "item": [ - { - "name": "Sign a Semantic CWT credential", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"iss\": \"\",\n \"vc\": {\n \"credentialSubject\": {\n \"minimeb\": \"\"\n },\n \"type\": \"\",\n \"@context\": \"\"\n },\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a signed Semantic CWT credential generated from a provided valid payload.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_SIGN_START\n* CREDENTIAL_COMPACT_SEMANTIC_SIGN_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_SIGN_FAIL" - }, - "response": [ - { - "name": "Semantic CWT credential signed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"iss\": \"\",\n \"vc\": {\n \"credentialSubject\": {\n \"minimeb\": \"\"\n },\n \"type\": \"\",\n \"@context\": \"\"\n },\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"encoded\": \"\",\n \"decoded\": {\n \"iss\": \"\",\n \"nbf\": \"\",\n \"jti\": \"\",\n \"vc\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"credentialSubject\": {\n \"eu0d1\": \"\"\n }\n },\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"status\": {\n \"url\": \"\",\n \"index\": \"\"\n }\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"iss\": \"\",\n \"vc\": {\n \"credentialSubject\": {\n \"minimeb\": \"\"\n },\n \"type\": \"\",\n \"@context\": \"\"\n },\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\"\n },\n \"revocable\": false,\n \"isRevoked\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Format a Semantic CWT credential as a QR code", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "image/png" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": \"\",\n \"width\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/qrcode", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "qrcode"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a QR code representation of a Semantic CWT credential from a provided encoded string representation of that credential.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_QRCODE_CREATE_FAIL" - }, - "response": [ - { - "name": "QR code generated", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "image/png" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": \"\",\n \"width\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/qrcode", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "qrcode" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "image/png" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": \"\",\n \"width\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/qrcode", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "qrcode" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Format a CWT credential as a PDF", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/pdf" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a PDF representation of a provided CWT credential based on an existing PDF template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_CREATE_FAIL" - }, - "response": [ - { - "name": "PDF created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/pdf" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/pdf" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "pdf"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Format a Semantic CWT credential as an Apple Pass", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/vnd.apple.pkpass" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns an Apple Pass representation of a provided Semantic CWT credential based on an existing Apple Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_CREATE_FAIL" - }, - "response": [ - { - "name": "Apple Pass created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/vnd.apple.pkpass" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/vnd.apple.pkpass" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Format a Semantic CWT credential as a Google Pass", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a Google Pass representation of a provided CWT credential based on an existing Google Pass template.\n\n> The request will fail if the provided credential isn't valid or has expired.\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_CREATE_FAIL" - }, - "response": [ - { - "name": "Google Pass created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"redirectTo\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"templateId\": \"\",\n \"payload\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for issuing Semantic CWT credentials." - }, - { - "name": "JSON credentials issuance", - "item": [ - { - "name": "Sign a JSON credential", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialSubject\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"@context\": [\n \"\",\n \"\"\n ],\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"expirationDate\": \"\",\n \"issuanceDate\": \"\"\n },\n \"proofType\": \"\",\n \"tag\": \"\",\n \"persist\": false,\n \"revocable\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a signed JSON credential generated from a provided valid payload.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_SIGN_START\n* CREDENTIAL_WEB_SEMANTIC_SIGN_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_SIGN_FAIL" - }, - "response": [ - { - "name": "JSON Credential signed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialSubject\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"@context\": [\n \"\",\n \"\"\n ],\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"expirationDate\": \"\",\n \"issuanceDate\": \"\"\n },\n \"proofType\": \"\",\n \"tag\": \"\",\n \"persist\": false,\n \"revocable\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"credential\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"@context\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"issuanceDate\": \"\",\n \"tag\": \"\",\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialSubject\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"@context\": [\n \"\",\n \"\"\n ],\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"expirationDate\": \"\",\n \"issuanceDate\": \"\"\n },\n \"proofType\": \"\",\n \"tag\": \"\",\n \"persist\": false,\n \"revocable\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/sign", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", "sign"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for issuing JSON credentials." - }, - { - "name": "CWT credential templates", - "item": [ - { - "name": "CWT credentials PDF templates", - "item": [ - { - "name": "Create a PDF template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/zip" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance/direct/compact/templates/pdf) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "PDF template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all PDF templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all CWT credentials PDF templates available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "PDF templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a PDF template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/zip" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Update an existing CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance/direct/compact/templates/pdf) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "PDF template updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a PDF template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing CWT credentials PDF template using its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "PDF template retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a PDF template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Delete an existing PDF template by providing its ID\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_PDF_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "PDF template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing CWT credentials PDF templates." - }, - { - "name": "CWT credentials Apple Pass templates", - "item": [ - { - "name": "Create an Apple Pass template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates an Apple Pass template based on the provided `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/apple) guide for more information on how to design the template and how to structure the `.zip` file.\n\n> The Apple Pass template uses the official Apple Pass bundle structure.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Apple Pass templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all Apple Pass template available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Apple Pass templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update an Apple Pass template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing Apple Pass template by providing its ID and a `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/apple) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve an Apple Pass template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an Apple Pass template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_APPLE_PASS_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing CWT credentials Apple Pass templates." - }, - { - "name": "CWT credentials Google Pass templates", - "item": [ - { - "name": "Create a Google Pass template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a Google Pass template based on the provided `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/google) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "Google Pass template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Google Pass templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all Google Pass templates available on your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Google Pass templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update a Google Pass template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates a existing Google Pass template by providing its ID and a `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/google) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "Google Pass template updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a Google Pass template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Google Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Google Pass templated retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a Google Pass template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing Google Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "Google Pass template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing CWT credentials Google Pass templates." - }, - { - "name": "Semantic CWT credentials PDF templates", - "item": [ - { - "name": "Create a PDF template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/zip" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a Semantic CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance/direct/compact/templates/pdf) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "PDF template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all PDF templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all Semantic CWT credential PDF templates available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "PDF templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a PDF template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/zip" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Update an existing CWT credential PDF template based on a provided `.zip` file. Refer to our [PDF template design guide](https://learn.mattr.global/guides/issuance/direct/compact/templates/pdf) for more information on how to design a template and structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "PDF template updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a PDF template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Semantic CWT credential PDF template using its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "PDF template retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"fileName\": \"\",\n \"fonts\": [\n {\n \"name\": \"\",\n \"fileName\": \"\"\n },\n {\n \"name\": \"\",\n \"fileName\": \"\"\n }\n ],\n \"metadata\": {\n \"title\": \"\"\n },\n \"fields\": [\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\",\n \"alternativeText\": \"\",\n \"isRequired\": \"\",\n \"fontName\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a PDF template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Delete an existing PDF template by providing its ID\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "PDF template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/pdf/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "pdf", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) PDF Template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Semantic CWT credentials PDF templates." - }, - { - "name": "Semantic CWT credentials Apple Pass templates", - "item": [ - { - "name": "Create an Apple Pass template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates an Apple Pass template based on the provided `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/apple) guide for more information on how to design the template and how to structure the `.zip` file.\n\n> The Apple Pass template uses the official Apple Pass bundle structure.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "value": "", - "description": "(Required) Includes your template files.", - "type": "text" - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "value": "", - "description": "(Required) Includes your template files.", - "type": "text" - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Apple Pass templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all Apple Pass template available on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Apple Pass templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update an Apple Pass template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing Apple Pass template by providing its ID and a `.zip` file. Refer to our [Design an Apple Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/apple) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Apple digital pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "fileName", - "value": "", - "description": "(Required) Insert the file name that will be assigned to Apple digital passes created from this template. Must only include alphanumeric characters, ''_'', or ''-'', and end with `.pkpass`.", - "type": "text" - }, - { - "key": "teamIdentifier", - "value": "", - "description": "(Required) The Team ID for the Apple Developer Program account that registered the pass type identifier.", - "type": "text" - }, - { - "key": "passTypeIdentifier", - "value": "", - "description": "(Required) The pass type identifier that’s registered with Apple. The value must be the same as the distribution certificate used to sign the pass.", - "type": "text" - }, - { - "key": "wwdr", - "value": "", - "description": "(Required) Apple G1 or G4 worldwide developer relations intermediate certificate.", - "type": "text" - }, - { - "key": "signerCert", - "value": "", - "description": "(Required) Apple pass [signer certificate](https://help.apple.com/developer-account/#/devbfa00fef7).", - "type": "text" - }, - { - "key": "signerKey", - "value": "", - "description": "(Required) The encrypted key of the Apple pass signer certificate.", - "type": "text" - }, - { - "key": "signerKeyPassphrase", - "value": "", - "description": "(Required) Passphrase for the encrypted key.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve an Apple Pass template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"fileName\": \"\",\n \"teamIdentifier\": \"\",\n \"passTypeIdentifier\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an Apple Pass template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing Apple Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_APPLE_PASS_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "Apple Pass template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/apple/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "apple", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Apple Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Semantic CWT credentials Apple Pass templates." - }, - { - "name": "Semantic CWT credentials Google Pass templates", - "item": [ - { - "name": "Create a Google Pass template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a Google Pass template based on the provided `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/google) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "Google Pass template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "value": "", - "description": "(Required) Includes your template files.", - "type": "text" - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "value": "", - "description": "(Required) Includes your template files.", - "type": "text" - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Google Pass templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves a list of all Google Pass templates available on your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Google Pass templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update a Google Pass template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates a existing Google Pass template by providing its ID and a `.zip` file. Refer to our [Design a Google Pass template](https://learn.mattr.global/guides/issuance/direct/compact/templates/google) guide for more information on how to design the template and how to structure the `.zip` file.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "Google Pass template updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "name", - "value": "", - "description": "(Required) Insert a name to identify this Google Pass template.", - "type": "text" - }, - { - "key": "template", - "description": "(Required) Includes your template files.", - "type": "file", - "src": [] - }, - { - "key": "issuerId", - "value": "", - "description": "(Required) Google Wallet Pass signer issuer ID.", - "type": "text" - }, - { - "key": "serviceAccountClientEmail", - "value": "", - "description": "(Required) Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.", - "type": "text" - }, - { - "key": "serviceAccountPrivateKey", - "value": "", - "description": "(Required) Private key PEM of the Google Cloud Platform service account.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a Google Pass template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Google Pass template by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Google Pass templated retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"passType\": \"\",\n \"name\": \"\",\n \"metadata\": {\n \"issuerId\": \"\",\n \"serviceAccountClientEmail\": \"\",\n \"payPassId\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a Google Pass template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Delete a Google Pay Pass template by ID\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "Google Pass template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/digital-pass/google/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "digital-pass", - "google", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Google Pass template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Semantic CWT credentials Google Pass templates." - } - ] - } - ] - }, - { - "name": "OID4VCI", - "item": [ - { - "name": "Authentication Provider", - "item": [ - { - "name": "Configure an Authentication Provider", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"url\": \"\",\n \"clientSecret\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", "authentication-providers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Configures an Authentication Provider on the tenant.\n\nAn authentication or identity provider (IdP) is a platform that is typically used to store and manage user accounts on behalf of an organization or a service provider. MATTR VII uses the authentication provider to authenticate end users before issuing them credentials.\n\n> Only one authentication provider can be configured on a tenant.\n\nThe `/.well-known/openid-configuration` endpoint of the Authentication Provider must contain values for the `authorization_endpoint`, `token_endpoint` and `scopes_supported`.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_CREATE_START\n* USER_AUTHENTICATION_PROVIDER_CREATE_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_CREATE_FAIL" - }, - "response": [ - { - "name": "Authentication Provider configured", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"url\": \"\",\n \"clientSecret\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"id\": \"\",\n \"redirectUrl\": \"\",\n \"url\": \"\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_basic\",\n \"staticRequestParameters\": {\n \"Ut6\": \"\",\n \"elit_a\": \"\",\n \"aliquipb7_\": \"\",\n \"dolore80\": \"\",\n \"aliquipf29\": \"\",\n \"aliquaf8\": \"\",\n \"essef\": \"\",\n \"ullamco4f\": \"\",\n \"nisi23\": \"\",\n \"aliqua_3\": \"\",\n \"quif5\": \"\",\n \"sed_6f\": \"\",\n \"eu_d\": \"\",\n \"inbab\": \"\",\n \"in__b\": \"\",\n \"Duis_018\": \"\",\n \"mollit_d5d\": \"\",\n \"aute_6\": \"\",\n \"anim_6\": \"\",\n \"Loremd\": \"\",\n \"sit9b\": \"\",\n \"aliquip_7c\": \"\",\n \"exercitation_a3\": \"\",\n \"aliqua6e0\": \"\",\n \"adipisicing294\": \"\",\n \"dolor80\": \"\",\n \"id_5\": \"\",\n \"elit_f\": \"\",\n \"exb9\": \"\",\n \"ut_1\": \"\",\n \"dolore0\": \"\",\n \"pariatur_296\": \"\",\n \"aute_dd7\": \"\",\n \"consequat443\": \"\",\n \"proident_b\": \"\",\n \"Lorem_9\": \"\",\n \"id_408\": \"\",\n \"incididunt__39\": \"\",\n \"exercitationbd\": \"\",\n \"mollit_7\": \"\",\n \"nisi785\": \"\",\n \"exercitationf\": \"\",\n \"non_ce\": \"\",\n \"labore2\": \"\",\n \"sint7__\": \"\",\n \"exercitation8e_\": \"\",\n \"laboris_f3\": \"\",\n \"cillumc7\": \"\",\n \"commodo_01\": \"\",\n \"ad2\": \"\",\n \"in6e\": \"\",\n \"cillum3_\": \"\",\n \"ut_9fa\": \"\",\n \"eu7fc\": \"\",\n \"nostrud_fe\": \"\",\n \"consequat_02\": \"\",\n \"eu98\": \"\",\n \"veniam479\": \"\",\n \"officia_c\": \"\",\n \"sint_e\": \"\",\n \"ad2e7\": \"\",\n \"essead\": \"\",\n \"mollit_ca0\": \"\",\n \"consectetur6\": \"\",\n \"sint_c\": \"\",\n \"dolor_23\": \"\",\n \"sunt_c\": \"\",\n \"nulla6\": \"\",\n \"ullamco1\": \"\",\n \"nulla9\": \"\",\n \"quis_cf\": \"\",\n \"exe3a\": \"\",\n \"adipisicing8f\": \"\",\n \"magna1\": \"\",\n \"Excepteur2\": \"\",\n \"velit_33e\": \"\",\n \"eu_c7\": \"\",\n \"voluptate_3ce\": \"\",\n \"voluptate1a\": \"\",\n \"exe\": \"\",\n \"ullamco6_\": \"\",\n \"nisi6f\": \"\",\n \"reprehenderite\": \"\",\n \"eu1c\": \"\",\n \"nostrud_34\": \"\",\n \"Excepteur456\": \"\",\n \"enimed4\": \"\",\n \"sintab3\": \"\",\n \"laborum66\": \"\",\n \"quis_4\": \"\",\n \"velit_7\": \"\",\n \"officiaaa\": \"\",\n \"aliquipc0\": \"\",\n \"sint_90\": \"\",\n \"ut_c\": \"\",\n \"irure_d3\": \"\",\n \"do_aed\": \"\",\n \"Lorem_4_\": \"\",\n \"proident_e\": \"\",\n \"anim_86\": \"\",\n \"sint11\": \"\",\n \"sit_a3\": \"\",\n \"nostrudc\": \"\",\n \"magna398\": \"\",\n \"Utf\": \"\",\n \"fugiat12\": \"\",\n \"do_49\": \"\",\n \"anima2\": \"\",\n \"aute_8a\": \"\",\n \"minim184\": \"\",\n \"nullac1\": \"\",\n \"ut8a9\": \"\",\n \"eu_0\": \"\",\n \"deserunt4b\": \"\",\n \"occaecat_c64\": \"\",\n \"minima\": \"\",\n \"aute8b\": \"\",\n \"Lorem_4\": \"\",\n \"laboris_7e\": \"\",\n \"in_47\": \"\",\n \"deserunt_2\": \"\",\n \"Excepteur822\": \"\",\n \"dolor_7b3\": \"\",\n \"reprehenderit_95\": \"\",\n \"ipsum1\": \"\",\n \"consequat_a\": \"\",\n \"Excepteura2f\": \"\",\n \"Lorem6\": \"\",\n \"in_a7\": \"\",\n \"quis7d\": \"\",\n \"culpa24d\": \"\",\n \"Duis654\": \"\",\n \"dolor1d0\": \"\",\n \"mollit6\": \"\",\n \"irure_42\": \"\",\n \"Lorem_b\": \"\",\n \"dolore_264\": \"\",\n \"Ut_2d\": \"\",\n \"proident_630\": \"\",\n \"consequat5a7\": \"\",\n \"voluptate_80f\": \"\",\n \"amet2\": \"\",\n \"Excepteur_5f4\": \"\",\n \"Excepteur_a0\": \"\",\n \"aute_64f\": \"\",\n \"irurecbb\": \"\",\n \"adipisicingd27\": \"\",\n \"reprehenderit_0\": \"\",\n \"inef\": \"\",\n \"ex7a5\": \"\",\n \"consequat4dd\": \"\",\n \"dolore_55\": \"\",\n \"ut6f2\": \"\",\n \"quis8\": \"\",\n \"fugiat_83d\": \"\",\n \"culpa6\": \"\",\n \"in_fb\": \"\",\n \"animd\": \"\",\n \"eu_9\": \"\",\n \"proidentac\": \"\",\n \"fugiat_8\": \"\",\n \"quis8b\": \"\",\n \"minim79f\": \"\",\n \"dolor60\": \"\",\n \"eiusmod__68\": \"\",\n \"anim_4d9\": \"\",\n \"veniam21f\": \"\",\n \"dolore54\": \"\",\n \"sunt_16\": \"\",\n \"culpa_0\": \"\",\n \"culpa71\": \"\",\n \"officia_5\": \"\",\n \"minim_6_\": \"\",\n \"aliquip__\": \"\",\n \"officia_6f\": \"\",\n \"suntc\": \"\",\n \"dolor5f\": \"\",\n \"et_f\": \"\",\n \"nisi8b0\": \"\",\n \"eiusmod_d\": \"\",\n \"ex_2\": \"\",\n \"utc7e\": \"\",\n \"dolor_7\": \"\",\n \"incididunt1c6\": \"\",\n \"veniam4ad\": \"\",\n \"sitd\": \"\",\n \"ullamco0b7\": \"\",\n \"sunt9\": \"\",\n \"ullamco9\": \"\",\n \"tempor487\": \"\",\n \"ut_2\": \"\",\n \"proident6\": \"\",\n \"ipsum_b7_\": \"\",\n \"officia_d\": \"\",\n \"adipisicing_d9\": \"\",\n \"inc\": \"\",\n \"culpa_c\": \"\",\n \"tempor6\": \"\",\n \"consecteturfa\": \"\",\n \"ut67\": \"\",\n \"id_3d2\": \"\",\n \"laborum_c35\": \"\",\n \"sed1\": \"\",\n \"sintf8\": \"\",\n \"velit_e\": \"\",\n \"doloree3\": \"\",\n \"aliquip2\": \"\",\n \"ad_7_\": \"\",\n \"aliqua_17\": \"\",\n \"nonea2\": \"\",\n \"commodo94\": \"\",\n \"Ut_a\": \"\",\n \"consequat_1ab\": \"\",\n \"aliqua_034\": \"\",\n \"in95_\": \"\",\n \"dolorb\": \"\",\n \"do_c42\": \"\",\n \"idc_c\": \"\",\n \"in7f\": \"\",\n \"et357\": \"\",\n \"minim_bb\": \"\",\n \"mollit__8\": \"\",\n \"officia_a\": \"\",\n \"in04e\": \"\",\n \"sit_b0\": \"\",\n \"deserunt0c\": \"\",\n \"dolorb_\": \"\",\n \"esse0\": \"\",\n \"ipsum5\": \"\",\n \"laborum3\": \"\",\n \"ipsum_36\": \"\",\n \"occaecat9\": \"\",\n \"aute_\": \"\",\n \"cillum5c4\": \"\",\n \"eaa7d\": \"\",\n \"elitbaf\": \"\",\n \"ipsum_a23\": \"\",\n \"idf\": \"\",\n \"exercitation_68b\": \"\",\n \"in_a\": \"\",\n \"consectetur_7b8\": \"\",\n \"Excepteur_24\": \"\",\n \"cupidatat_01f\": \"\",\n \"adipisicing_dee\": \"\",\n \"sint_3d_\": \"\",\n \"Ut_f8\": \"\",\n \"est7ca\": \"\",\n \"anim0\": \"\",\n \"in45c\": \"\",\n \"adipisicing3e\": \"\",\n \"sunt4f\": \"\",\n \"sunt_0\": \"\",\n \"incididunt11\": \"\",\n \"sed0\": \"\",\n \"irure_166\": \"\",\n \"id_76d\": \"\",\n \"sit4\": \"\",\n \"anim86\": \"\",\n \"sunt_8e\": \"\",\n \"amet_8\": \"\",\n \"aute_7b0\": \"\",\n \"ea2\": \"\",\n \"sunt_9d2\": \"\",\n \"dolor4bd\": \"\",\n \"laborum0d\": \"\",\n \"autea\": \"\",\n \"Duis_64\": \"\",\n \"suntf\": \"\",\n \"estce2\": \"\",\n \"commodo_8a\": \"\",\n \"sint_d0_\": \"\",\n \"pariatur2\": \"\",\n \"essedf8\": \"\",\n \"dolor_3_\": \"\",\n \"laborum0fd\": \"\",\n \"ex_20c\": \"\",\n \"aliqua_b4_\": \"\",\n \"irure33d\": \"\",\n \"minim1\": \"\",\n \"ut_95f\": \"\",\n \"voluptate_cf\": \"\",\n \"ameta\": \"\",\n \"non_f\": \"\",\n \"veniam_bfc\": \"\",\n \"nullae3\": \"\",\n \"ut_83\": \"\",\n \"Ut9\": \"\",\n \"laboris_908\": \"\",\n \"ea0\": \"\",\n \"tempor499\": \"\",\n \"veniame4\": \"\",\n \"elitd\": \"\",\n \"Excepteur_\": \"\",\n \"proident_f\": \"\",\n \"ullamco441\": \"\",\n \"qui9\": \"\",\n \"cupidatatb0\": \"\",\n \"ex_3e\": \"\",\n \"dolor_52\": \"\",\n \"sint_559\": \"\",\n \"qui8b\": \"\",\n \"in_7_\": \"\",\n \"sit_ba\": \"\",\n \"adipisicingd9\": \"\",\n \"aliqua_bf\": \"\",\n \"mollita\": \"\",\n \"cillume3\": \"\",\n \"non_6\": \"\",\n \"anim__\": \"\",\n \"amet56_\": \"\",\n \"velitb\": \"\",\n \"dolore_d65\": \"\",\n \"sunta_3\": \"\",\n \"in_d\": \"\",\n \"Ut_357\": \"\",\n \"reprehenderit4\": \"\",\n \"laborum_6d8\": \"\",\n \"ipsum_be\": \"\",\n \"adipisicing_270\": \"\",\n \"ad1f2\": \"\",\n \"dolor_a\": \"\",\n \"dolore_4b\": \"\",\n \"pariatur952\": \"\",\n \"aliquip_5f7\": \"\",\n \"pariatur10e\": \"\",\n \"dolor9\": \"\",\n \"nisi_b98\": \"\",\n \"sunt_f\": \"\",\n \"fugiat_ca\": \"\",\n \"aute_9c\": \"\",\n \"magnab3f\": \"\",\n \"Excepteur_27\": \"\",\n \"dolor_3\": \"\",\n \"voluptate_c3\": \"\",\n \"aliqua_ed\": \"\",\n \"labore_c8d\": \"\",\n \"sunt_eb\": \"\",\n \"et_dd\": \"\",\n \"commodo_62_\": \"\",\n \"aliquip0\": \"\",\n \"minim_ba1\": \"\",\n \"pariatur383\": \"\",\n \"dolor_b5\": \"\",\n \"quis_3\": \"\",\n \"veniam6\": \"\",\n \"officia2\": \"\",\n \"enim_1\": \"\",\n \"ipsum_dd\": \"\",\n \"deserunt3\": \"\",\n \"minim_7b\": \"\",\n \"irure__0\": \"\",\n \"reprehenderit64\": \"\",\n \"ipsum3_9\": \"\",\n \"sunted\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"url\": \"\",\n \"clientSecret\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Authentication Providers", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", "authentication-providers"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all Authentication Providers on your tenant.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_START\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Authentication Providers retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"id\": \"\",\n \"redirectUrl\": \"\",\n \"url\": \"\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_basic\",\n \"staticRequestParameters\": {\n \"in_a6\": \"\",\n \"inef\": \"\",\n \"consectetur7\": \"\",\n \"cillumb7b\": \"\",\n \"labore_29\": \"\",\n \"dolor7b1\": \"\",\n \"ipsum_399\": \"\",\n \"inbeb\": \"\",\n \"officia31\": \"\",\n \"velit_\": \"\",\n \"do5\": \"\",\n \"ullamco_e8\": \"\",\n \"adae\": \"\",\n \"tempor0\": \"\",\n \"cillum__\": \"\",\n \"mollit_0ba\": \"\",\n \"Lorem_110\": \"\",\n \"labore_74\": \"\",\n \"Lorem62\": \"\",\n \"commodod91\": \"\",\n \"ea30\": \"\",\n \"in2\": \"\",\n \"incididunt_7a3\": \"\",\n \"magna_0\": \"\",\n \"dolor9e\": \"\",\n \"consectetur_fc5\": \"\",\n \"culpaa4\": \"\",\n \"aliquip_6\": \"\",\n \"reprehenderit7\": \"\",\n \"fugiat_246\": \"\",\n \"adipisicing_9d_\": \"\",\n \"dolor_af4\": \"\",\n \"non3d\": \"\",\n \"id19\": \"\",\n \"adipisicing_df2\": \"\",\n \"ullamco_b\": \"\",\n \"ullamco7\": \"\",\n \"exercitationa\": \"\",\n \"mollit4\": \"\",\n \"Duis_6\": \"\",\n \"est_2\": \"\",\n \"est5\": \"\",\n \"minim_a8\": \"\",\n \"consecteturd31\": \"\",\n \"id_627\": \"\",\n \"dolor_e47\": \"\",\n \"aliqua__\": \"\",\n \"fugiatf3\": \"\",\n \"cillum_\": \"\",\n \"ea42f\": \"\",\n \"fugiat_d\": \"\",\n \"non_\": \"\",\n \"ameta_7\": \"\",\n \"eiusmod1f\": \"\",\n \"etfa5\": \"\",\n \"pariatur_b3\": \"\",\n \"nostrud8d\": \"\",\n \"enim45c\": \"\",\n \"dolore_d\": \"\",\n \"ide\": \"\",\n \"tempor9b\": \"\",\n \"velitaaf\": \"\",\n \"deserunt1\": \"\",\n \"eua1\": \"\",\n \"Lorem_e1\": \"\",\n \"cillum_6c9\": \"\",\n \"elit_eb\": \"\",\n \"reprehenderit8\": \"\",\n \"consectetur_e5a\": \"\",\n \"laborum_2_8\": \"\",\n \"Lorem_5\": \"\",\n \"none\": \"\",\n \"est65e\": \"\",\n \"est_6b\": \"\",\n \"nisi2\": \"\",\n \"laborum62f\": \"\",\n \"ullamco_e\": \"\",\n \"ex_5_5\": \"\",\n \"officia_8\": \"\",\n \"Utb\": \"\",\n \"adipisicing3c\": \"\",\n \"do_ae0\": \"\",\n \"ad_8d\": \"\",\n \"Loremb\": \"\",\n \"nulla308\": \"\",\n \"voluptate545\": \"\",\n \"labore_d\": \"\",\n \"consectetur_9e\": \"\",\n \"ea_4\": \"\",\n \"deserunt_079\": \"\",\n \"culpa_de_\": \"\",\n \"laborum_cfd\": \"\",\n \"etaf1\": \"\",\n \"aliqua_72f\": \"\",\n \"mollita\": \"\",\n \"voluptate6\": \"\",\n \"ea19\": \"\",\n \"consequatee2\": \"\",\n \"Duis__f\": \"\",\n \"Duis5\": \"\",\n \"Lorem77f\": \"\",\n \"ut3\": \"\",\n \"consecteturf\": \"\",\n \"irurec\": \"\",\n \"commodo_2\": \"\",\n \"esse9\": \"\",\n \"tempor_3\": \"\",\n \"dolor8\": \"\",\n \"utb78\": \"\",\n \"sunt_86\": \"\",\n \"consequat5\": \"\",\n \"culpa2\": \"\",\n \"in_d9\": \"\",\n \"magna_11b\": \"\",\n \"Lorem_6\": \"\",\n \"exercitation443\": \"\",\n \"aute_4a\": \"\",\n \"nulla_d\": \"\",\n \"in_f6\": \"\",\n \"mollit_8b4\": \"\",\n \"aliquip2\": \"\",\n \"pariatur9\": \"\",\n \"exercitationaa\": \"\",\n \"exercitation_0e\": \"\",\n \"adipisicing_3\": \"\",\n \"id_d2c\": \"\",\n \"magna__68\": \"\",\n \"dolor_d1\": \"\",\n \"consequat_0\": \"\",\n \"eaa_\": \"\",\n \"ind\": \"\",\n \"minim__4\": \"\",\n \"aliqua0f\": \"\",\n \"est_c\": \"\",\n \"sit_e1\": \"\",\n \"in87\": \"\",\n \"cillum_01\": \"\",\n \"est_e92\": \"\",\n \"sed53d\": \"\",\n \"ut0e5\": \"\",\n \"consequat_f98\": \"\",\n \"dolor15\": \"\",\n \"quis_7f\": \"\",\n \"Duis_9d\": \"\",\n \"proident71\": \"\",\n \"sit___\": \"\",\n \"pariatur_6b7\": \"\",\n \"velit4e\": \"\",\n \"esse54a\": \"\",\n \"sit_4d6\": \"\",\n \"temporb0\": \"\",\n \"eiusmod66b\": \"\",\n \"consectetur_10d\": \"\",\n \"occaecat3b\": \"\",\n \"ut_e9\": \"\",\n \"Duis_1bc\": \"\",\n \"Utd\": \"\",\n \"minim_5_7\": \"\",\n \"est_e19\": \"\",\n \"ad53\": \"\",\n \"dolor364\": \"\",\n \"ex_8e\": \"\",\n \"velit_98\": \"\",\n \"estb5f\": \"\",\n \"officia_fdb\": \"\",\n \"minimf\": \"\",\n \"do_71\": \"\",\n \"non_2_\": \"\",\n \"nonf\": \"\",\n \"consequat_46b\": \"\",\n \"nisi334\": \"\",\n \"qui0\": \"\",\n \"nulla91b\": \"\",\n \"estf5\": \"\",\n \"mollit_b\": \"\",\n \"velit_03_\": \"\",\n \"dolore_6\": \"\",\n \"pariatura\": \"\",\n \"labore2e\": \"\",\n \"in_6b\": \"\",\n \"ullamco89f\": \"\",\n \"laboris2d\": \"\",\n \"officia8\": \"\",\n \"occaecat_8a\": \"\",\n \"in_53b\": \"\",\n \"Ut_\": \"\",\n \"officia9\": \"\",\n \"commodoec\": \"\",\n \"esse7b5\": \"\",\n \"Duis_e05\": \"\",\n \"ut08\": \"\",\n \"amet6\": \"\",\n \"id_15\": \"\",\n \"exercitation_812\": \"\",\n \"proident33\": \"\",\n \"laborum_\": \"\",\n \"eiusmod_9bb\": \"\",\n \"deserunt0f\": \"\",\n \"Loremd42\": \"\",\n \"id21f\": \"\",\n \"incididunt_928\": \"\",\n \"aute_\": \"\",\n \"in_30_\": \"\",\n \"in_b\": \"\",\n \"laborum0d\": \"\",\n \"ut_e\": \"\",\n \"aliqua_9a8\": \"\",\n \"ut_bd9\": \"\",\n \"ullamco_0\": \"\",\n \"cupidatat6c2\": \"\",\n \"dolore_fa0\": \"\",\n \"reprehenderit_853\": \"\",\n \"pariatur_8b\": \"\",\n \"doloreb1\": \"\",\n \"laboris__\": \"\",\n \"Ut__3a\": \"\",\n \"occaecat_a81\": \"\",\n \"tempor__d9\": \"\",\n \"non3\": \"\",\n \"anim_c\": \"\",\n \"anim_f_6\": \"\",\n \"commodo_73\": \"\",\n \"fugiat28\": \"\",\n \"et2e\": \"\",\n \"Ut_cf\": \"\",\n \"magna6a\": \"\",\n \"sed5\": \"\",\n \"culpa_9a\": \"\",\n \"nostrud__\": \"\",\n \"voluptate49\": \"\",\n \"tempor__4\": \"\",\n \"exercitation_2a\": \"\",\n \"ullamco_d\": \"\",\n \"exercitation_521\": \"\",\n \"ut_2c\": \"\",\n \"ut_2\": \"\",\n \"magna4_4\": \"\",\n \"dolor_02\": \"\",\n \"nostrud_c\": \"\",\n \"nulla_1\": \"\",\n \"et349\": \"\",\n \"cillum_f\": \"\",\n \"aliquip_c9\": \"\",\n \"velit6\": \"\",\n \"ad_4\": \"\",\n \"in_e1e\": \"\",\n \"in_9e8\": \"\",\n \"sunt28d\": \"\",\n \"consequat7\": \"\",\n \"sed_7\": \"\",\n \"reprehenderit0\": \"\",\n \"culpa_f4\": \"\",\n \"in6\": \"\",\n \"eu_158\": \"\",\n \"minim_5cc\": \"\",\n \"nisi_d5\": \"\",\n \"do4\": \"\",\n \"dolore_adb\": \"\",\n \"cillumd\": \"\",\n \"suntcd\": \"\",\n \"in5\": \"\",\n \"officia_24\": \"\",\n \"irure1_b\": \"\",\n \"nulla7\": \"\",\n \"Utb_6\": \"\",\n \"aliqua8aa\": \"\",\n \"ex_536\": \"\",\n \"est__e1\": \"\",\n \"irure_1\": \"\",\n \"voluptate8\": \"\",\n \"nostrud_\": \"\",\n \"irure_b20\": \"\",\n \"dolore6f8\": \"\",\n \"laboris3\": \"\",\n \"voluptate_6e\": \"\",\n \"voluptateca0\": \"\",\n \"sunt_4\": \"\",\n \"labore_1d3\": \"\",\n \"est_e7\": \"\",\n \"veniam_5d\": \"\",\n \"ut_1c6\": \"\",\n \"laborum_5\": \"\",\n \"sit_24b\": \"\",\n \"in32a\": \"\",\n \"in96e\": \"\",\n \"Duis_42\": \"\",\n \"laborum175\": \"\",\n \"officia4\": \"\",\n \"Excepteur_408\": \"\"\n }\n },\n {\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"id\": \"\",\n \"redirectUrl\": \"\",\n \"url\": \"\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_basic\",\n \"staticRequestParameters\": {\n \"ex62_\": \"\",\n \"estf\": \"\",\n \"elit_9\": \"\",\n \"Excepteur_39a\": \"\",\n \"fugiat_1a\": \"\",\n \"amet931\": \"\",\n \"adipisicingc21\": \"\",\n \"cupidatat_1a\": \"\",\n \"eafda\": \"\",\n \"in49\": \"\",\n \"sed__\": \"\",\n \"exercitationd7_\": \"\",\n \"aliqua68\": \"\",\n \"commodo377\": \"\",\n \"officiaf1\": \"\",\n \"dolor4\": \"\",\n \"ex8\": \"\",\n \"dolore218\": \"\",\n \"laborum4b\": \"\",\n \"fugiat07e\": \"\",\n \"culpa3a4\": \"\",\n \"eiusmod0\": \"\",\n \"nullaf\": \"\",\n \"dolor_113\": \"\",\n \"id_7b\": \"\",\n \"sed4\": \"\",\n \"dolore_93b\": \"\",\n \"deserunt_53c\": \"\",\n \"aute__\": \"\",\n \"in0a\": \"\",\n \"esse_9b0\": \"\",\n \"occaecat26e\": \"\",\n \"deserunt35f\": \"\",\n \"anim_045\": \"\",\n \"Loremb3\": \"\",\n \"mollit_8c4\": \"\",\n \"culpa_ba9\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve an Authentication Provider", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve an existing Authentication Provider by providing its ID.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_START\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Authentication Provider retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"id\": \"\",\n \"redirectUrl\": \"\",\n \"url\": \"\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_basic\",\n \"staticRequestParameters\": {\n \"Ut6\": \"\",\n \"elit_a\": \"\",\n \"aliquipb7_\": \"\",\n \"dolore80\": \"\",\n \"aliquipf29\": \"\",\n \"aliquaf8\": \"\",\n \"essef\": \"\",\n \"ullamco4f\": \"\",\n \"nisi23\": \"\",\n \"aliqua_3\": \"\",\n \"quif5\": \"\",\n \"sed_6f\": \"\",\n \"eu_d\": \"\",\n \"inbab\": \"\",\n \"in__b\": \"\",\n \"Duis_018\": \"\",\n \"mollit_d5d\": \"\",\n \"aute_6\": \"\",\n \"anim_6\": \"\",\n \"Loremd\": \"\",\n \"sit9b\": \"\",\n \"aliquip_7c\": \"\",\n \"exercitation_a3\": \"\",\n \"aliqua6e0\": \"\",\n \"adipisicing294\": \"\",\n \"dolor80\": \"\",\n \"id_5\": \"\",\n \"elit_f\": \"\",\n \"exb9\": \"\",\n \"ut_1\": \"\",\n \"dolore0\": \"\",\n \"pariatur_296\": \"\",\n \"aute_dd7\": \"\",\n \"consequat443\": \"\",\n \"proident_b\": \"\",\n \"Lorem_9\": \"\",\n \"id_408\": \"\",\n \"incididunt__39\": \"\",\n \"exercitationbd\": \"\",\n \"mollit_7\": \"\",\n \"nisi785\": \"\",\n \"exercitationf\": \"\",\n \"non_ce\": \"\",\n \"labore2\": \"\",\n \"sint7__\": \"\",\n \"exercitation8e_\": \"\",\n \"laboris_f3\": \"\",\n \"cillumc7\": \"\",\n \"commodo_01\": \"\",\n \"ad2\": \"\",\n \"in6e\": \"\",\n \"cillum3_\": \"\",\n \"ut_9fa\": \"\",\n \"eu7fc\": \"\",\n \"nostrud_fe\": \"\",\n \"consequat_02\": \"\",\n \"eu98\": \"\",\n \"veniam479\": \"\",\n \"officia_c\": \"\",\n \"sint_e\": \"\",\n \"ad2e7\": \"\",\n \"essead\": \"\",\n \"mollit_ca0\": \"\",\n \"consectetur6\": \"\",\n \"sint_c\": \"\",\n \"dolor_23\": \"\",\n \"sunt_c\": \"\",\n \"nulla6\": \"\",\n \"ullamco1\": \"\",\n \"nulla9\": \"\",\n \"quis_cf\": \"\",\n \"exe3a\": \"\",\n \"adipisicing8f\": \"\",\n \"magna1\": \"\",\n \"Excepteur2\": \"\",\n \"velit_33e\": \"\",\n \"eu_c7\": \"\",\n \"voluptate_3ce\": \"\",\n \"voluptate1a\": \"\",\n \"exe\": \"\",\n \"ullamco6_\": \"\",\n \"nisi6f\": \"\",\n \"reprehenderite\": \"\",\n \"eu1c\": \"\",\n \"nostrud_34\": \"\",\n \"Excepteur456\": \"\",\n \"enimed4\": \"\",\n \"sintab3\": \"\",\n \"laborum66\": \"\",\n \"quis_4\": \"\",\n \"velit_7\": \"\",\n \"officiaaa\": \"\",\n \"aliquipc0\": \"\",\n \"sint_90\": \"\",\n \"ut_c\": \"\",\n \"irure_d3\": \"\",\n \"do_aed\": \"\",\n \"Lorem_4_\": \"\",\n \"proident_e\": \"\",\n \"anim_86\": \"\",\n \"sint11\": \"\",\n \"sit_a3\": \"\",\n \"nostrudc\": \"\",\n \"magna398\": \"\",\n \"Utf\": \"\",\n \"fugiat12\": \"\",\n \"do_49\": \"\",\n \"anima2\": \"\",\n \"aute_8a\": \"\",\n \"minim184\": \"\",\n \"nullac1\": \"\",\n \"ut8a9\": \"\",\n \"eu_0\": \"\",\n \"deserunt4b\": \"\",\n \"occaecat_c64\": \"\",\n \"minima\": \"\",\n \"aute8b\": \"\",\n \"Lorem_4\": \"\",\n \"laboris_7e\": \"\",\n \"in_47\": \"\",\n \"deserunt_2\": \"\",\n \"Excepteur822\": \"\",\n \"dolor_7b3\": \"\",\n \"reprehenderit_95\": \"\",\n \"ipsum1\": \"\",\n \"consequat_a\": \"\",\n \"Excepteura2f\": \"\",\n \"Lorem6\": \"\",\n \"in_a7\": \"\",\n \"quis7d\": \"\",\n \"culpa24d\": \"\",\n \"Duis654\": \"\",\n \"dolor1d0\": \"\",\n \"mollit6\": \"\",\n \"irure_42\": \"\",\n \"Lorem_b\": \"\",\n \"dolore_264\": \"\",\n \"Ut_2d\": \"\",\n \"proident_630\": \"\",\n \"consequat5a7\": \"\",\n \"voluptate_80f\": \"\",\n \"amet2\": \"\",\n \"Excepteur_5f4\": \"\",\n \"Excepteur_a0\": \"\",\n \"aute_64f\": \"\",\n \"irurecbb\": \"\",\n \"adipisicingd27\": \"\",\n \"reprehenderit_0\": \"\",\n \"inef\": \"\",\n \"ex7a5\": \"\",\n \"consequat4dd\": \"\",\n \"dolore_55\": \"\",\n \"ut6f2\": \"\",\n \"quis8\": \"\",\n \"fugiat_83d\": \"\",\n \"culpa6\": \"\",\n \"in_fb\": \"\",\n \"animd\": \"\",\n \"eu_9\": \"\",\n \"proidentac\": \"\",\n \"fugiat_8\": \"\",\n \"quis8b\": \"\",\n \"minim79f\": \"\",\n \"dolor60\": \"\",\n \"eiusmod__68\": \"\",\n \"anim_4d9\": \"\",\n \"veniam21f\": \"\",\n \"dolore54\": \"\",\n \"sunt_16\": \"\",\n \"culpa_0\": \"\",\n \"culpa71\": \"\",\n \"officia_5\": \"\",\n \"minim_6_\": \"\",\n \"aliquip__\": \"\",\n \"officia_6f\": \"\",\n \"suntc\": \"\",\n \"dolor5f\": \"\",\n \"et_f\": \"\",\n \"nisi8b0\": \"\",\n \"eiusmod_d\": \"\",\n \"ex_2\": \"\",\n \"utc7e\": \"\",\n \"dolor_7\": \"\",\n \"incididunt1c6\": \"\",\n \"veniam4ad\": \"\",\n \"sitd\": \"\",\n \"ullamco0b7\": \"\",\n \"sunt9\": \"\",\n \"ullamco9\": \"\",\n \"tempor487\": \"\",\n \"ut_2\": \"\",\n \"proident6\": \"\",\n \"ipsum_b7_\": \"\",\n \"officia_d\": \"\",\n \"adipisicing_d9\": \"\",\n \"inc\": \"\",\n \"culpa_c\": \"\",\n \"tempor6\": \"\",\n \"consecteturfa\": \"\",\n \"ut67\": \"\",\n \"id_3d2\": \"\",\n \"laborum_c35\": \"\",\n \"sed1\": \"\",\n \"sintf8\": \"\",\n \"velit_e\": \"\",\n \"doloree3\": \"\",\n \"aliquip2\": \"\",\n \"ad_7_\": \"\",\n \"aliqua_17\": \"\",\n \"nonea2\": \"\",\n \"commodo94\": \"\",\n \"Ut_a\": \"\",\n \"consequat_1ab\": \"\",\n \"aliqua_034\": \"\",\n \"in95_\": \"\",\n \"dolorb\": \"\",\n \"do_c42\": \"\",\n \"idc_c\": \"\",\n \"in7f\": \"\",\n \"et357\": \"\",\n \"minim_bb\": \"\",\n \"mollit__8\": \"\",\n \"officia_a\": \"\",\n \"in04e\": \"\",\n \"sit_b0\": \"\",\n \"deserunt0c\": \"\",\n \"dolorb_\": \"\",\n \"esse0\": \"\",\n \"ipsum5\": \"\",\n \"laborum3\": \"\",\n \"ipsum_36\": \"\",\n \"occaecat9\": \"\",\n \"aute_\": \"\",\n \"cillum5c4\": \"\",\n \"eaa7d\": \"\",\n \"elitbaf\": \"\",\n \"ipsum_a23\": \"\",\n \"idf\": \"\",\n \"exercitation_68b\": \"\",\n \"in_a\": \"\",\n \"consectetur_7b8\": \"\",\n \"Excepteur_24\": \"\",\n \"cupidatat_01f\": \"\",\n \"adipisicing_dee\": \"\",\n \"sint_3d_\": \"\",\n \"Ut_f8\": \"\",\n \"est7ca\": \"\",\n \"anim0\": \"\",\n \"in45c\": \"\",\n \"adipisicing3e\": \"\",\n \"sunt4f\": \"\",\n \"sunt_0\": \"\",\n \"incididunt11\": \"\",\n \"sed0\": \"\",\n \"irure_166\": \"\",\n \"id_76d\": \"\",\n \"sit4\": \"\",\n \"anim86\": \"\",\n \"sunt_8e\": \"\",\n \"amet_8\": \"\",\n \"aute_7b0\": \"\",\n \"ea2\": \"\",\n \"sunt_9d2\": \"\",\n \"dolor4bd\": \"\",\n \"laborum0d\": \"\",\n \"autea\": \"\",\n \"Duis_64\": \"\",\n \"suntf\": \"\",\n \"estce2\": \"\",\n \"commodo_8a\": \"\",\n \"sint_d0_\": \"\",\n \"pariatur2\": \"\",\n \"essedf8\": \"\",\n \"dolor_3_\": \"\",\n \"laborum0fd\": \"\",\n \"ex_20c\": \"\",\n \"aliqua_b4_\": \"\",\n \"irure33d\": \"\",\n \"minim1\": \"\",\n \"ut_95f\": \"\",\n \"voluptate_cf\": \"\",\n \"ameta\": \"\",\n \"non_f\": \"\",\n \"veniam_bfc\": \"\",\n \"nullae3\": \"\",\n \"ut_83\": \"\",\n \"Ut9\": \"\",\n \"laboris_908\": \"\",\n \"ea0\": \"\",\n \"tempor499\": \"\",\n \"veniame4\": \"\",\n \"elitd\": \"\",\n \"Excepteur_\": \"\",\n \"proident_f\": \"\",\n \"ullamco441\": \"\",\n \"qui9\": \"\",\n \"cupidatatb0\": \"\",\n \"ex_3e\": \"\",\n \"dolor_52\": \"\",\n \"sint_559\": \"\",\n \"qui8b\": \"\",\n \"in_7_\": \"\",\n \"sit_ba\": \"\",\n \"adipisicingd9\": \"\",\n \"aliqua_bf\": \"\",\n \"mollita\": \"\",\n \"cillume3\": \"\",\n \"non_6\": \"\",\n \"anim__\": \"\",\n \"amet56_\": \"\",\n \"velitb\": \"\",\n \"dolore_d65\": \"\",\n \"sunta_3\": \"\",\n \"in_d\": \"\",\n \"Ut_357\": \"\",\n \"reprehenderit4\": \"\",\n \"laborum_6d8\": \"\",\n \"ipsum_be\": \"\",\n \"adipisicing_270\": \"\",\n \"ad1f2\": \"\",\n \"dolor_a\": \"\",\n \"dolore_4b\": \"\",\n \"pariatur952\": \"\",\n \"aliquip_5f7\": \"\",\n \"pariatur10e\": \"\",\n \"dolor9\": \"\",\n \"nisi_b98\": \"\",\n \"sunt_f\": \"\",\n \"fugiat_ca\": \"\",\n \"aute_9c\": \"\",\n \"magnab3f\": \"\",\n \"Excepteur_27\": \"\",\n \"dolor_3\": \"\",\n \"voluptate_c3\": \"\",\n \"aliqua_ed\": \"\",\n \"labore_c8d\": \"\",\n \"sunt_eb\": \"\",\n \"et_dd\": \"\",\n \"commodo_62_\": \"\",\n \"aliquip0\": \"\",\n \"minim_ba1\": \"\",\n \"pariatur383\": \"\",\n \"dolor_b5\": \"\",\n \"quis_3\": \"\",\n \"veniam6\": \"\",\n \"officia2\": \"\",\n \"enim_1\": \"\",\n \"ipsum_dd\": \"\",\n \"deserunt3\": \"\",\n \"minim_7b\": \"\",\n \"irure__0\": \"\",\n \"reprehenderit64\": \"\",\n \"ipsum3_9\": \"\",\n \"sunted\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update an Authentication Provider", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"value\": \"", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing Authentication Provider by providing its ID.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_UPDATE_START\n* USER_AUTHENTICATION_PROVIDER_UPDATE_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "Authentication Provider updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"value\": \"", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"id\": \"\",\n \"redirectUrl\": \"\",\n \"url\": \"\",\n \"scope\": [\n \"openid\",\n \"profile\",\n \"email\"\n ],\n \"tokenEndpointAuthMethod\": \"client_secret_basic\",\n \"staticRequestParameters\": {\n \"Ut6\": \"\",\n \"elit_a\": \"\",\n \"aliquipb7_\": \"\",\n \"dolore80\": \"\",\n \"aliquipf29\": \"\",\n \"aliquaf8\": \"\",\n \"essef\": \"\",\n \"ullamco4f\": \"\",\n \"nisi23\": \"\",\n \"aliqua_3\": \"\",\n \"quif5\": \"\",\n \"sed_6f\": \"\",\n \"eu_d\": \"\",\n \"inbab\": \"\",\n \"in__b\": \"\",\n \"Duis_018\": \"\",\n \"mollit_d5d\": \"\",\n \"aute_6\": \"\",\n \"anim_6\": \"\",\n \"Loremd\": \"\",\n \"sit9b\": \"\",\n \"aliquip_7c\": \"\",\n \"exercitation_a3\": \"\",\n \"aliqua6e0\": \"\",\n \"adipisicing294\": \"\",\n \"dolor80\": \"\",\n \"id_5\": \"\",\n \"elit_f\": \"\",\n \"exb9\": \"\",\n \"ut_1\": \"\",\n \"dolore0\": \"\",\n \"pariatur_296\": \"\",\n \"aute_dd7\": \"\",\n \"consequat443\": \"\",\n \"proident_b\": \"\",\n \"Lorem_9\": \"\",\n \"id_408\": \"\",\n \"incididunt__39\": \"\",\n \"exercitationbd\": \"\",\n \"mollit_7\": \"\",\n \"nisi785\": \"\",\n \"exercitationf\": \"\",\n \"non_ce\": \"\",\n \"labore2\": \"\",\n \"sint7__\": \"\",\n \"exercitation8e_\": \"\",\n \"laboris_f3\": \"\",\n \"cillumc7\": \"\",\n \"commodo_01\": \"\",\n \"ad2\": \"\",\n \"in6e\": \"\",\n \"cillum3_\": \"\",\n \"ut_9fa\": \"\",\n \"eu7fc\": \"\",\n \"nostrud_fe\": \"\",\n \"consequat_02\": \"\",\n \"eu98\": \"\",\n \"veniam479\": \"\",\n \"officia_c\": \"\",\n \"sint_e\": \"\",\n \"ad2e7\": \"\",\n \"essead\": \"\",\n \"mollit_ca0\": \"\",\n \"consectetur6\": \"\",\n \"sint_c\": \"\",\n \"dolor_23\": \"\",\n \"sunt_c\": \"\",\n \"nulla6\": \"\",\n \"ullamco1\": \"\",\n \"nulla9\": \"\",\n \"quis_cf\": \"\",\n \"exe3a\": \"\",\n \"adipisicing8f\": \"\",\n \"magna1\": \"\",\n \"Excepteur2\": \"\",\n \"velit_33e\": \"\",\n \"eu_c7\": \"\",\n \"voluptate_3ce\": \"\",\n \"voluptate1a\": \"\",\n \"exe\": \"\",\n \"ullamco6_\": \"\",\n \"nisi6f\": \"\",\n \"reprehenderite\": \"\",\n \"eu1c\": \"\",\n \"nostrud_34\": \"\",\n \"Excepteur456\": \"\",\n \"enimed4\": \"\",\n \"sintab3\": \"\",\n \"laborum66\": \"\",\n \"quis_4\": \"\",\n \"velit_7\": \"\",\n \"officiaaa\": \"\",\n \"aliquipc0\": \"\",\n \"sint_90\": \"\",\n \"ut_c\": \"\",\n \"irure_d3\": \"\",\n \"do_aed\": \"\",\n \"Lorem_4_\": \"\",\n \"proident_e\": \"\",\n \"anim_86\": \"\",\n \"sint11\": \"\",\n \"sit_a3\": \"\",\n \"nostrudc\": \"\",\n \"magna398\": \"\",\n \"Utf\": \"\",\n \"fugiat12\": \"\",\n \"do_49\": \"\",\n \"anima2\": \"\",\n \"aute_8a\": \"\",\n \"minim184\": \"\",\n \"nullac1\": \"\",\n \"ut8a9\": \"\",\n \"eu_0\": \"\",\n \"deserunt4b\": \"\",\n \"occaecat_c64\": \"\",\n \"minima\": \"\",\n \"aute8b\": \"\",\n \"Lorem_4\": \"\",\n \"laboris_7e\": \"\",\n \"in_47\": \"\",\n \"deserunt_2\": \"\",\n \"Excepteur822\": \"\",\n \"dolor_7b3\": \"\",\n \"reprehenderit_95\": \"\",\n \"ipsum1\": \"\",\n \"consequat_a\": \"\",\n \"Excepteura2f\": \"\",\n \"Lorem6\": \"\",\n \"in_a7\": \"\",\n \"quis7d\": \"\",\n \"culpa24d\": \"\",\n \"Duis654\": \"\",\n \"dolor1d0\": \"\",\n \"mollit6\": \"\",\n \"irure_42\": \"\",\n \"Lorem_b\": \"\",\n \"dolore_264\": \"\",\n \"Ut_2d\": \"\",\n \"proident_630\": \"\",\n \"consequat5a7\": \"\",\n \"voluptate_80f\": \"\",\n \"amet2\": \"\",\n \"Excepteur_5f4\": \"\",\n \"Excepteur_a0\": \"\",\n \"aute_64f\": \"\",\n \"irurecbb\": \"\",\n \"adipisicingd27\": \"\",\n \"reprehenderit_0\": \"\",\n \"inef\": \"\",\n \"ex7a5\": \"\",\n \"consequat4dd\": \"\",\n \"dolore_55\": \"\",\n \"ut6f2\": \"\",\n \"quis8\": \"\",\n \"fugiat_83d\": \"\",\n \"culpa6\": \"\",\n \"in_fb\": \"\",\n \"animd\": \"\",\n \"eu_9\": \"\",\n \"proidentac\": \"\",\n \"fugiat_8\": \"\",\n \"quis8b\": \"\",\n \"minim79f\": \"\",\n \"dolor60\": \"\",\n \"eiusmod__68\": \"\",\n \"anim_4d9\": \"\",\n \"veniam21f\": \"\",\n \"dolore54\": \"\",\n \"sunt_16\": \"\",\n \"culpa_0\": \"\",\n \"culpa71\": \"\",\n \"officia_5\": \"\",\n \"minim_6_\": \"\",\n \"aliquip__\": \"\",\n \"officia_6f\": \"\",\n \"suntc\": \"\",\n \"dolor5f\": \"\",\n \"et_f\": \"\",\n \"nisi8b0\": \"\",\n \"eiusmod_d\": \"\",\n \"ex_2\": \"\",\n \"utc7e\": \"\",\n \"dolor_7\": \"\",\n \"incididunt1c6\": \"\",\n \"veniam4ad\": \"\",\n \"sitd\": \"\",\n \"ullamco0b7\": \"\",\n \"sunt9\": \"\",\n \"ullamco9\": \"\",\n \"tempor487\": \"\",\n \"ut_2\": \"\",\n \"proident6\": \"\",\n \"ipsum_b7_\": \"\",\n \"officia_d\": \"\",\n \"adipisicing_d9\": \"\",\n \"inc\": \"\",\n \"culpa_c\": \"\",\n \"tempor6\": \"\",\n \"consecteturfa\": \"\",\n \"ut67\": \"\",\n \"id_3d2\": \"\",\n \"laborum_c35\": \"\",\n \"sed1\": \"\",\n \"sintf8\": \"\",\n \"velit_e\": \"\",\n \"doloree3\": \"\",\n \"aliquip2\": \"\",\n \"ad_7_\": \"\",\n \"aliqua_17\": \"\",\n \"nonea2\": \"\",\n \"commodo94\": \"\",\n \"Ut_a\": \"\",\n \"consequat_1ab\": \"\",\n \"aliqua_034\": \"\",\n \"in95_\": \"\",\n \"dolorb\": \"\",\n \"do_c42\": \"\",\n \"idc_c\": \"\",\n \"in7f\": \"\",\n \"et357\": \"\",\n \"minim_bb\": \"\",\n \"mollit__8\": \"\",\n \"officia_a\": \"\",\n \"in04e\": \"\",\n \"sit_b0\": \"\",\n \"deserunt0c\": \"\",\n \"dolorb_\": \"\",\n \"esse0\": \"\",\n \"ipsum5\": \"\",\n \"laborum3\": \"\",\n \"ipsum_36\": \"\",\n \"occaecat9\": \"\",\n \"aute_\": \"\",\n \"cillum5c4\": \"\",\n \"eaa7d\": \"\",\n \"elitbaf\": \"\",\n \"ipsum_a23\": \"\",\n \"idf\": \"\",\n \"exercitation_68b\": \"\",\n \"in_a\": \"\",\n \"consectetur_7b8\": \"\",\n \"Excepteur_24\": \"\",\n \"cupidatat_01f\": \"\",\n \"adipisicing_dee\": \"\",\n \"sint_3d_\": \"\",\n \"Ut_f8\": \"\",\n \"est7ca\": \"\",\n \"anim0\": \"\",\n \"in45c\": \"\",\n \"adipisicing3e\": \"\",\n \"sunt4f\": \"\",\n \"sunt_0\": \"\",\n \"incididunt11\": \"\",\n \"sed0\": \"\",\n \"irure_166\": \"\",\n \"id_76d\": \"\",\n \"sit4\": \"\",\n \"anim86\": \"\",\n \"sunt_8e\": \"\",\n \"amet_8\": \"\",\n \"aute_7b0\": \"\",\n \"ea2\": \"\",\n \"sunt_9d2\": \"\",\n \"dolor4bd\": \"\",\n \"laborum0d\": \"\",\n \"autea\": \"\",\n \"Duis_64\": \"\",\n \"suntf\": \"\",\n \"estce2\": \"\",\n \"commodo_8a\": \"\",\n \"sint_d0_\": \"\",\n \"pariatur2\": \"\",\n \"essedf8\": \"\",\n \"dolor_3_\": \"\",\n \"laborum0fd\": \"\",\n \"ex_20c\": \"\",\n \"aliqua_b4_\": \"\",\n \"irure33d\": \"\",\n \"minim1\": \"\",\n \"ut_95f\": \"\",\n \"voluptate_cf\": \"\",\n \"ameta\": \"\",\n \"non_f\": \"\",\n \"veniam_bfc\": \"\",\n \"nullae3\": \"\",\n \"ut_83\": \"\",\n \"Ut9\": \"\",\n \"laboris_908\": \"\",\n \"ea0\": \"\",\n \"tempor499\": \"\",\n \"veniame4\": \"\",\n \"elitd\": \"\",\n \"Excepteur_\": \"\",\n \"proident_f\": \"\",\n \"ullamco441\": \"\",\n \"qui9\": \"\",\n \"cupidatatb0\": \"\",\n \"ex_3e\": \"\",\n \"dolor_52\": \"\",\n \"sint_559\": \"\",\n \"qui8b\": \"\",\n \"in_7_\": \"\",\n \"sit_ba\": \"\",\n \"adipisicingd9\": \"\",\n \"aliqua_bf\": \"\",\n \"mollita\": \"\",\n \"cillume3\": \"\",\n \"non_6\": \"\",\n \"anim__\": \"\",\n \"amet56_\": \"\",\n \"velitb\": \"\",\n \"dolore_d65\": \"\",\n \"sunta_3\": \"\",\n \"in_d\": \"\",\n \"Ut_357\": \"\",\n \"reprehenderit4\": \"\",\n \"laborum_6d8\": \"\",\n \"ipsum_be\": \"\",\n \"adipisicing_270\": \"\",\n \"ad1f2\": \"\",\n \"dolor_a\": \"\",\n \"dolore_4b\": \"\",\n \"pariatur952\": \"\",\n \"aliquip_5f7\": \"\",\n \"pariatur10e\": \"\",\n \"dolor9\": \"\",\n \"nisi_b98\": \"\",\n \"sunt_f\": \"\",\n \"fugiat_ca\": \"\",\n \"aute_9c\": \"\",\n \"magnab3f\": \"\",\n \"Excepteur_27\": \"\",\n \"dolor_3\": \"\",\n \"voluptate_c3\": \"\",\n \"aliqua_ed\": \"\",\n \"labore_c8d\": \"\",\n \"sunt_eb\": \"\",\n \"et_dd\": \"\",\n \"commodo_62_\": \"\",\n \"aliquip0\": \"\",\n \"minim_ba1\": \"\",\n \"pariatur383\": \"\",\n \"dolor_b5\": \"\",\n \"quis_3\": \"\",\n \"veniam6\": \"\",\n \"officia2\": \"\",\n \"enim_1\": \"\",\n \"ipsum_dd\": \"\",\n \"deserunt3\": \"\",\n \"minim_7b\": \"\",\n \"irure__0\": \"\",\n \"reprehenderit64\": \"\",\n \"ipsum3_9\": \"\",\n \"sunted\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"value\": \"", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"value\": \"", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an Authentication Provider", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing Authentication Provider by providing its ID.\n\n### **Analytic events**\n* USER_AUTHENTICATION_PROVIDER_DELETE_START\n* USER_AUTHENTICATION_PROVIDER_DELETE_SUCCESS\n* USER_AUTHENTICATION_PROVIDER_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Authentication Provider deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/authentication-providers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v1", - "users", - "authentication-providers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Authentication Provider ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Authentication providers for OID4VCI workflows." - }, - { - "name": "Interaction Hook", - "item": [ - { - "name": "Configure Interaction Hook", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"interactionHook\": {\n \"url\": \"\",\n \"sessionTimeoutInSec\": \"\",\n \"disabled\": true\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/configuration", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Configure the Interaction Hook for the OpenID4VCI protocol on your tenant.\nMany credential issuance journeys require the issuer to perform custom interactions with the user. This could be gathering more information, performing additional authentication steps (E.g, 2FA, MFA or biometric checks) or communicating the terms of service. To facilitate this requirement, you can configure MATTR VII to invoke an interaction hook which will redirect the user to a custom component during the credential issuance journey. This redirect happens **after** the user is authenticated with your configured identity provider but **before** the credential is issued to the user. Upon successful completion of the interaction hook, your custom component will redirect the user back to their digital wallet to complete the credential issuance flow. Your interaction hook component can be either a web or native application.  We recommend using a web interface because it's more compatible with most scenarios.\n> You can only configure one interaction hook on your MATTR VII tenant. If you require several custom interactions as part of the credential issuance workflow, they should all be linked into a single interaction hook component.\n\n### **Analytic events**\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_START\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_UPDATE_FAIL" - }, - "response": [ - { - "name": "Interaction Hook configured", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"interactionHook\": {\n \"url\": \"\",\n \"sessionTimeoutInSec\": \"\",\n \"disabled\": true\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/configuration", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"interactionHook\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"interactionHook\": {\n \"url\": \"\",\n \"sessionTimeoutInSec\": \"\",\n \"disabled\": true\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/configuration", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve Interaction Hook", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/openid/configuration", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves the Interaction Hook configuration from your tenant.\n\n### **Analytic events**\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_PROVIDER_OPENID_CONFIGURATION_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Interaction Hook configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/openid/configuration", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "configuration"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"interactionHook\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Interaction hooks for OID4VCI workflows." - }, - { - "name": "Claims Source", - "item": [ - { - "name": "Configure a claims source", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Configures a new claims source for your tenant. When issuing a new credential, MATTR VII will make either a GET or a POST request to the claims source using the configured request parameters and fetch available data. This fetched data can then be included in the issued credential.\n\n### **Analytic event**\n* CLAIM_SOURCE_CREATE_START\n* CLAIM_SOURCE_CREATE_SUCCESS\n* CLAIM_SOURCE_CREATE_FAIL\n" - }, - "response": [ - { - "name": "Claims source configured", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"requestMethod\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all claims sources", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources?limit=&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources"], - "query": [ - { - "key": "limit", - "value": "", - "description": "Range size of returned entries, default 100" - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the range of entries" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all claims sources configured on your tenant.\n\n### **Analytic event**\n* CLAIM_SOURCE_RETRIEVE_LIST_START\n* CLAIM_SOURCE_RETRIEVE_LIST_SUCCESS\n* CLAIM_SOURCE_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Claims sources retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources?limit=&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources"], - "query": [ - { - "key": "limit", - "value": "" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"requestMethod\": \"\"\n },\n {\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"requestMethod\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources?limit=&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources"], - "query": [ - { - "key": "limit", - "value": "" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a claims source", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing claims source by providing its `claimSourceID`.\n\n### **Analytic event**\n* CLAIM_SOURCE_RETRIEVE_START\n* CLAIM_SOURCE_RETRIEVE_SUCCESS\n* CLAIM_SOURCE_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Claims source retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"requestMethod\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Claims source not found", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Update a claims source", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing claim source by providing its `claimSourceID`.\n\n### **Analytic event**\n* CLAIM_SOURCE_UPDATE_START\n* CLAIM_SOURCE_UPDATE_SUCCESS\n* CLAIM_SOURCE_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "Claims source updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"id\": \"\",\n \"requestMethod\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Claims source not found", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"authorization\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"name\": \"\",\n \"requestParameters\": {\n \"mapFrom\": \"\"\n },\n \"url\": \"\",\n \"requestMethod\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a claims source", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing claims source by providing its `claimSourceID`.\n\n### **Analytic event**\n* CLAIM_SOURCE_DELETE_START\n* CLAIM_SOURCE_DELETE_SUCCESS\n* CLAIM_SOURCE_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Claims source deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Claims source not found", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/claim-sources/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "claim-sources", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Claims source ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Claim sources for OID4VCI workflows." - }, - { - "name": "CWT credentials configuration", - "item": [ - { - "name": "Create a CWT credential configuration", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "configurations"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new CWT 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.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" - }, - "response": [ - { - "name": "CWT credential configuration created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"claimMappings\": {\n \"laborum3e8\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"proident_1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": \"\",\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all CWT credential configurations", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "configurations"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - }, - { - "key": "type", - "value": "", - "description": "The optional credential type to filter on" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all CWT credential configurations from your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "CWT credential configurations retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"claimMappings\": {\n \"occaecat_f0f\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"proident_6\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": \"\",\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n },\n {\n \"claimMappings\": {\n \"et_fed\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"tempor_cd4\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": \"\",\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a CWT credential configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a CWT credential configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "CWT credential configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"claimMappings\": {\n \"laborum3e8\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"proident_1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": \"\",\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a CWT credential configuration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing CWT credential configuration by providing its ID.\n \n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "CWT credential configuration updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"claimMappings\": {\n \"laborum3e8\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"proident_1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": \"\",\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"ipsum_6d9\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": \"\",\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a CWT credential configuration", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing CWT credential configuration by providing its ID.\n \n### **Analytic events**\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_START\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" - }, - "response": [ - { - "name": "CWT credential configuration deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the CWT credential configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for creating CWT credentials configuration." - }, - { - "name": "Semantic CWT credentials configuration", - "item": [ - { - "name": "Create a Semantic CWT credentials configuration", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new Semantic CWT credentials 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.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" - }, - "response": [ - { - "name": "Credential configuration created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"claimMappings\": {\n \"quis4\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"ipsume\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Semantic CWT credentials configurations", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - }, - { - "key": "type", - "value": "", - "description": "The optional credential type to filter on" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all Compact Semantic Credential configurations from your tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Semantic CWT credentials configurations retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"claimMappings\": {\n \"minim_ec8\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"ut38\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n },\n {\n \"claimMappings\": {\n \"Duis_6\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"aute_c0\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a Semantic CWT credentials configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a Semantic CWT credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Semantic CWT credentials configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"claimMappings\": {\n \"quis4\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"ipsume\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a Semantic CWT credentials configuration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing Semantic CWT credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "Semantic CWT credentials configuration updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"claimMappings\": {\n \"quis4\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"ipsume\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"id\": \"\",\n \"revocable\": true,\n \"type\": {},\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claimMappings\": {\n \"dolorec\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"type\": {},\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Delete a Semantic CWT credentials configuration", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing Semantic CWT credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Semantic CWT credentials configuration deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the Semantic CWT credentials configuration." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for creating Semantic CWT credentials configuration." - }, - { - "name": "JSON credentials configuration", - "item": [ - { - "name": "Create a JSON credentials configuration", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"dolore92e\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"commodo11\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new JSON credentials 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.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" - }, - "response": [ - { - "name": "JSON credentials configuration created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"ullamco_e1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"dolorc6\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"esse_2b_\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"ullamco_e1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all JSON credentials configurations", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - }, - { - "key": "type", - "value": "", - "description": "The optional credential type to filter on" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all JSON credential configurations on your tenant.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "JSON credentials configurations retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"dolor83f\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"aute6__\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"eu_de1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"minimbf\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"quis_2\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"laborisa6\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"tempor_60\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"culpaae_\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a JSON credentials configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve a JSON credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "JSON credentials configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"dolorc6\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"esse_2b_\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a JSON credentials configuration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"dolore92e\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"commodo11\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing JSON credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "JSON credentials configuration updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"ullamco_e1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"persist\": false,\n \"revocable\": true,\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"dolorc6\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n },\n \"esse_2b_\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"ullamco_e1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"issuer\": {\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"description\": \"\",\n \"additionalTypes\": [\n \"\",\n \"\"\n ],\n \"contexts\": [\n \"\",\n \"\"\n ],\n \"proofType\": \"\",\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"claimMappings\": {\n \"ullamco_e1\": {\n \"mapFrom\": \"\",\n \"required\": \"\",\n \"defaultValue\": \"\"\n }\n },\n \"persist\": false,\n \"revocable\": true,\n \"claimSourceId\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a JSON credentials configuration", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing JSON credentials configuration by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_START\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" - }, - "response": [ - { - "name": "JSON credentials configuration deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "The credential configuration is not found", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v2/credentials/web-semantic/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "core", - "v2", - "credentials", - "web-semantic", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) JSON credentials configuration unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing JSON credentials configuration." - }, - { - "name": "mDoc credentials configuration", - "item": [ - { - "name": "Create an mDocs configuration", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "configurations"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new mDocs 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.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_CREATE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_CREATE_FAIL\n" - }, - "response": [ - { - "name": "mDocs configuration created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "configurations"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false,\n \"claimSourceId\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "configurations"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all mDocs configurations", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "configurations"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - }, - { - "key": "type", - "value": "", - "description": "Optional credential type to filter on" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all mDocs configurations from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "mDocs configurations retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "configurations"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false,\n \"claimSourceId\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false,\n \"claimSourceId\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations?limit=100&cursor=&type=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "configurations"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - }, - { - "key": "type", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve an mDocs configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing mDocs configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "mDocs configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false,\n \"claimSourceId\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update an mDocs configuration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing mDocs configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "mDocs configuration updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false,\n \"claimSourceId\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"type\": \"\",\n \"expiresIn\": {\n \"years\": \"\",\n \"months\": \"\",\n \"weeks\": \"\",\n \"days\": \"\",\n \"hours\": \"\",\n \"minutes\": \"\",\n \"seconds\": \"\"\n },\n \"claimMappings\": {\n \"additionalProperties\": {\n \"additionalProperties\": {\n \"mapFrom\": \"\",\n \"type\": \"\",\n \"required\": false,\n \"defaultValue\": \"\"\n }\n }\n },\n \"claimSourceId\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"includeStatus\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an mDocs configuration", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing mDocs configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_CONFIGURATION_DELETE_START\n* MOBILE_CREDENTIAL_CONFIGURATION_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_CONFIGURATION_DELETE_FAIL\n" - }, - "response": [ - { - "name": "mDocs configuration deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDocs configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing mDocs credentials configuration." - }, - { - "name": "Credential issuance", - "item": [ - { - "name": "Request authorization for access to resources", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/authorize?response_type=&client_id=&redirect_uri=&scope=&state=&code_challenge_method=&code_challenge=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "authorize"], - "query": [ - { - "key": "response_type", - "value": "", - "description": "(Required) The response type, which must be 'code'." - }, - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The URI to which the authorization server will redirect the user-agent with the authorization code." - }, - { - "key": "scope", - "value": "", - "description": "(Required) The scope of the access request." - }, - { - "key": "state", - "value": "", - "description": "An opaque value used by the client to maintain state between the request and callback." - }, - { - "key": "code_challenge_method", - "value": "", - "description": "(Required) The method used to derive the code_challenge, which must be 'S256'." - }, - { - "key": "code_challenge", - "value": "", - "description": "(Required) A high entropy random challenge generated by the client." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "This endpoint is used to request authorization from the user for access to the requested resources. After the user approves the request, an authorization code is returned to the client.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-authorization-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-authorization-endpoint)\nSee [https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1](https://www.rfc-editor.org/rfc/rfc6749.html#section-3.1)\n\n### **Analytic events**\n* OPENID_AUTHORIZE_START\n* OPENID_AUTHORIZE_SUCCESS\n* OPENID_AUTHORIZE_FAIL\n" - }, - "response": [ - { - "name": "Redirection to client application with authorization code", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/authorize?response_type=&client_id=&redirect_uri=&scope=&state=&code_challenge_method=&code_challenge=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "authorize"], - "query": [ - { - "key": "response_type", - "value": "" - }, - { - "key": "client_id", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - }, - { - "key": "scope", - "value": "" - }, - { - "key": "state", - "value": "" - }, - { - "key": "code_challenge_method", - "value": "" - }, - { - "key": "code_challenge", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Found", - "code": 302, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Location", - "value": "", - "description": "URL to redirect to with the authorization code" - }, - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/authorize?response_type=&client_id=&redirect_uri=&scope=&state=&code_challenge_method=&code_challenge=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "authorize"], - "query": [ - { - "key": "response_type", - "value": "" - }, - { - "key": "client_id", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - }, - { - "key": "scope", - "value": "" - }, - { - "key": "state", - "value": "" - }, - { - "key": "code_challenge_method", - "value": "" - }, - { - "key": "code_challenge", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/authorize?response_type=&client_id=&redirect_uri=&scope=&state=&code_challenge_method=&code_challenge=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "authorize"], - "query": [ - { - "key": "response_type", - "value": "" - }, - { - "key": "client_id", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - }, - { - "key": "scope", - "value": "" - }, - { - "key": "state", - "value": "" - }, - { - "key": "code_challenge_method", - "value": "" - }, - { - "key": "code_challenge", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/authorize?response_type=&client_id=&redirect_uri=&scope=&state=&code_challenge_method=&code_challenge=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "authorize"], - "query": [ - { - "key": "response_type", - "value": "" - }, - { - "key": "client_id", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - }, - { - "key": "scope", - "value": "" - }, - { - "key": "state", - "value": "" - }, - { - "key": "code_challenge_method", - "value": "" - }, - { - "key": "code_challenge", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/authorize?response_type=&client_id=&redirect_uri=&scope=&state=&code_challenge_method=&code_challenge=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "authorize"], - "query": [ - { - "key": "response_type", - "value": "" - }, - { - "key": "client_id", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - }, - { - "key": "scope", - "value": "" - }, - { - "key": "state", - "value": "" - }, - { - "key": "code_challenge_method", - "value": "" - }, - { - "key": "code_challenge", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Exchange authorization code for access token", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/x-www-form-urlencoded" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "grant_type", - "value": "", - "description": "(Required) The grant type, which must be 'authorization_code'." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The redirect URI that was used in the authorization request." - }, - { - "key": "code", - "value": "", - "description": "(Required) The authorization code obtained from the authorization endpoint." - }, - { - "key": "code_verifier", - "value": "", - "description": "(Required) SHA256 hash of the `code_challenge` in the authorization request." - } - ] - }, - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/token", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "This endpoint is used to exchange an authorization code for an access token. The authorization code is obtained from the authorization endpoint after the user has authenticated and granted access.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-token-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-token-endpoint)\n\n### **Analytic events**\n* OPENID_TOKEN_START\n* OPENID_TOKEN_SUCCESS\n* OPENID_TOKEN_FAIL\n" - }, - "response": [ - { - "name": "Access token successfully returned.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "grant_type", - "value": "", - "description": "(Required) The grant type, which must be 'authorization_code'." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The redirect URI that was used in the authorization request." - }, - { - "key": "code", - "value": "", - "description": "(Required) The authorization code obtained from the authorization endpoint." - }, - { - "key": "code_verifier", - "value": "", - "description": "(Required) SHA256 hash of the `code_challenge` in the authorization request." - } - ] - }, - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/token", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"expires_in\": \"\",\n \"scope\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "grant_type", - "value": "", - "description": "(Required) The grant type, which must be 'authorization_code'." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The redirect URI that was used in the authorization request." - }, - { - "key": "code", - "value": "", - "description": "(Required) The authorization code obtained from the authorization endpoint." - }, - { - "key": "code_verifier", - "value": "", - "description": "(Required) SHA256 hash of the `code_challenge` in the authorization request." - } - ] - }, - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/token", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Unauthorized. The client is not recognized by authorization server.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "grant_type", - "value": "", - "description": "(Required) The grant type, which must be 'authorization_code'." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The redirect URI that was used in the authorization request." - }, - { - "key": "code", - "value": "", - "description": "(Required) The authorization code obtained from the authorization endpoint." - }, - { - "key": "code_verifier", - "value": "", - "description": "(Required) SHA256 hash of the `code_challenge` in the authorization request." - } - ] - }, - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/token", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Unauthorized", - "code": 401, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Forbidden. The client is recognized by authorization server but is not allowed to access this resource.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "grant_type", - "value": "", - "description": "(Required) The grant type, which must be 'authorization_code'." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The redirect URI that was used in the authorization request." - }, - { - "key": "code", - "value": "", - "description": "(Required) The authorization code obtained from the authorization endpoint." - }, - { - "key": "code_verifier", - "value": "", - "description": "(Required) SHA256 hash of the `code_challenge` in the authorization request." - } - ] - }, - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/token", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Forbidden", - "code": 403, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Internal Server Error. An unexpected error occurred.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_id", - "value": "", - "description": "(Required) The client identifier." - }, - { - "key": "grant_type", - "value": "", - "description": "(Required) The grant type, which must be 'authorization_code'." - }, - { - "key": "redirect_uri", - "value": "", - "description": "(Required) The redirect URI that was used in the authorization request." - }, - { - "key": "code", - "value": "", - "description": "(Required) The authorization code obtained from the authorization endpoint." - }, - { - "key": "code_verifier", - "value": "", - "description": "(Required) SHA256 hash of the `code_challenge` in the authorization request." - } - ] - }, - "url": { - "raw": "{{baseUrl}}/core/v1/oauth/token", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "oauth", "token"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Internal Server Error", - "code": 500, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Issue a verifiable credential", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"format\": \"\",\n \"credential_definition\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"@context\": [\n \"\",\n \"\"\n ]\n },\n \"proof\": {\n \"proof_type\": \"\",\n \"jwt\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/credential", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "credential"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Issues a verifiable credential to a subject as part of the OpenID4VCI protocol.\n\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-endpoint](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#name-credential-endpoint)\n\n### **Analytic events**\n* OPENID_CREDENTIAL_START\n* OPENID_CREDENTIAL_SUCCESS\n* OPENID_CREDENTIAL_FAIL" - }, - "response": [ - { - "name": "Credential issued", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"format\": \"\",\n \"credential_definition\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"@context\": [\n \"\",\n \"\"\n ]\n },\n \"proof\": {\n \"proof_type\": \"\",\n \"jwt\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/credential", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "credential"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"credential\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"format\": \"\"\n}" - } - ] - }, - { - "name": "Create an OpenID4VCI credential offer", - "request": { - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}", - "type": "string" - } - ] - }, - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentials\": [\n \"\",\n \"\"\n ],\n \"request_parameters\": {\n \"login_hint\": \"\",\n \"prompt\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/offers", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "offers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns an OpenID4VCI credential offer URI.\nSee [https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html#section-10.1)\n\n### **Analytic events**\n* OPENID_OFFER_CREATE_START\n* OPENID_OFFER_CREATE_SUCCESS\n* OPENID_OFFER_CREATE_FAIL" - }, - "response": [ - { - "name": "Credential offer URI created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"credentials\": [\n \"\",\n \"\"\n ],\n \"request_parameters\": {\n \"login_hint\": \"\",\n \"prompt\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/openid/offers", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "openid", "offers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"uri\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve OpenID4VCI issuer metadata", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/.well-known/openid-credential-issuer", - "host": ["{{baseUrl}}"], - "path": [".well-known", "openid-credential-issuer"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns OpenID4VCI issuer metadata. This is the standard OpenID4VCI Well Known endpoint for your tenant.\n\nThis endpoint is unprotected, public facing and can be deterministically found at the root of the tenant subdomain or alias by any party wishing to discover the OpenID4VCI capabilities." - }, - "response": [ - { - "name": "OpenID4VCI credential issuer metadata retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/.well-known/openid-credential-issuer", - "host": ["{{baseUrl}}"], - "path": [".well-known", "openid-credential-issuer"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"issuer\": \"\",\n \"authorization_endpoint\": \"\",\n \"token_endpoint\": \"\",\n \"scopes_supported\": [\n \"\",\n \"\"\n ],\n \"response_types_supported\": [\n \"\",\n \"\"\n ],\n \"response_modes_supported\": [\n \"\",\n \"\"\n ],\n \"grant_types_supported\": [\n \"\",\n \"\"\n ],\n \"code_challenge_methods_supported\": [\n \"\",\n \"\"\n ],\n \"credential_issuer\": \"\",\n \"credential_endpoint\": \"\",\n \"credentials_supported\": [\n {\n \"format\": \"\",\n \"id\": \"\",\n \"scope\": \"\",\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"credentialSubject\": \"\",\n \"cryptographic_binding_methods_supported\": \"\",\n \"cryptographic_suites_supported\": \"\"\n },\n {\n \"format\": \"\",\n \"id\": \"\",\n \"scope\": \"\",\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"credentialSubject\": \"\",\n \"cryptographic_binding_methods_supported\": \"\",\n \"cryptographic_suites_supported\": \"\"\n }\n ],\n \"mdoc_iacas_uri\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for issuing credentials as part of an OID4VCI workflow." - }, - { - "name": "Users", - "item": [ - { - "name": "Search users", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\",\n \"authenticationProvider\": {\n \"providerId\": \"\",\n \"subjectId\": \"\"\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/search", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", "search"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of users from the tenant that match all the provided search criteria (all criteria are optional).\n\n### **Analytic events**\n* USER_SEARCH_START\n* USER_SEARCH_SUCCESS\n* USER_SEARCH_FAIL" - }, - "response": [ - { - "name": "Users retrieved", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\",\n \"authenticationProvider\": {\n \"providerId\": \"\",\n \"subjectId\": \"\"\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/search", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", "search"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"claims\": \"\",\n \"authenticationProvider\": {\n \"url\": \"\",\n \"subjectId\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"claims\": \"\",\n \"authenticationProvider\": {\n \"url\": \"\",\n \"subjectId\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\",\n \"authenticationProvider\": {\n \"providerId\": \"\",\n \"subjectId\": \"\"\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/search", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", "search"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all users", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all users on your tenant.\n\n### **Analytic events**\n* USER_RETRIEVE_LIST_START\n* USER_RETRIEVE_LIST_SUCCESS\n* USER_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Users retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"claims\": \"\"\n },\n {\n \"id\": \"\",\n \"claims\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a user", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve an existing user by providing its ID.\n* USER_RETRIEVE_START\n* USER_RETRIEVE_SUCCESS\n* USER_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "User retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"claims\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a User", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing user by providing its ID.\n\n* USER_UPDATE_START\n* USER_UPDATE_SUCCESS\n* USER_UPDATE_FAIL" - }, - "response": [ - { - "name": "User updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"claims\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"claims\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a user", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes a user and removes any persisted data related to them by providing the user ID.\n\n> Any credentials issued to the user remain valid even after the user is deleted.\n \n### **Analytic events**\n* USER_DELETE_START\n* USER_DELETE_SUCCESS\n* USER_DELETE_FAIL" - }, - "response": [ - { - "name": "User deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:id", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all user credentials data", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:userId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":userId", "credentials"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "userId", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of metadata for all the credentials referenced by the provided `userId`.\n" - }, - "response": [ - { - "name": "User credentials retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:userId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":userId", "credentials"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "userId", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"\",\n \"profile\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\",\n \"profile\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/core/v1/users/:userId/credentials?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["core", "v1", "users", ":userId", "credentials"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "userId", - "value": "", - "description": "(Required) User ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing users as part of OID4VCI workflows." - } - ] - }, - { - "name": "Credential management", - "item": [ - { - "name": "CWT credentials management", - "item": [ - { - "name": "Delete CWT credential metadata", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.\n\nNote that only metadata of revocable credentials or credentials issued via the OpenID4VCI flow is saved.\n\n> Deleted metadata cannot be recovered." - }, - "response": [ - { - "name": "Credential metadata deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all CWT credential revocation lists", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "revocation-lists"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all CWT credential revocation lists on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_START\n* CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_REVOCATION_LISTS_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Revocation lists retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "revocation-lists" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "[\n {\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n }\n ]\n },\n {\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n }\n ]\n }\n]" - } - ] - }, - { - "name": "Retrieve CWT credential revocation list", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/cwt" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists/:listId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "revocation-lists", - ":listId" - ], - "variable": [ - { - "key": "listId", - "value": "", - "description": "(Required) The unique identifier of the Revocation List you wish to retrieve." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a CWT credential revocation list by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_REVOCATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Revocation list retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/cwt" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/revocation-lists/:listId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - "revocation-lists", - ":listId" - ], - "variable": [ - { - "key": "listId", - "value": "", - "description": "(Required) The unique identifier of the Revocation List you wish to retrieve." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/cwt" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Update CWT credential revocation status", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates the credential status as revoked (invalid) or unrevoked (valid).\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_START\n* CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_SUCCESS\n* CREDENTIAL_COMPACT_REVOCATION_SET_STATUS_FAIL" - }, - "response": [ - { - "name": "Revocation status updated", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"isRevoked\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve CWT credential revocation status", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve the revocation status of a CWT credential by providing its ID." - }, - "response": [ - { - "name": "Revocation status retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"isRevoked\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing CWT credentials." - }, - { - "name": "Semantic CWT credentials management", - "item": [ - { - "name": "Delete Semantic CWT credential metadata", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes all credential metadata from the tenant for a specific credential by providing its ID. If the credential was set to be revocable, it will be permanently revoked upon metadata deletion.\n\nNote that only metadata of revocable credentials or credentials issued via the OpenID4VCI flow is saved.\n\n> Deleted metadata cannot be recovered." - }, - "response": [ - { - "name": "Credential metadata deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all Semantic CWT credential revocation lists", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "revocation-lists" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all Semantic CWT credential revocation lists on the tenant.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_LISTS_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Revocation lists retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "revocation-lists" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "[\n {\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n }\n ]\n },\n {\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"issuer\": \"\",\n \"url\": \"\"\n }\n ]\n }\n]" - } - ] - }, - { - "name": "Retrieve Semantic CWT credential revocation list", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/cwt" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists/:listId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "revocation-lists", - ":listId" - ], - "variable": [ - { - "key": "listId", - "value": "", - "description": "(Required) The unique identifier of the revocation list you wish to retrieve." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a Semantic CWT credential revocation list by providing its ID.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_START\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Revocation list retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/cwt" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/revocation-lists/:listId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "revocation-lists", - ":listId" - ], - "variable": [ - { - "key": "listId", - "value": "", - "description": "(Required) The unique identifier of the revocation list you wish to retrieve." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/cwt" - } - ], - "cookie": [], - "body": "" - } - ] - }, - { - "name": "Update Semantic CWT credential revocation status", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier (`jti`)" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates the credential status as revoked (invalid) or unrevoked (valid).\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_START\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_REVOCATION_SET_STATUS_FAIL" - }, - "response": [ - { - "name": "Revocation status updated", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier (`jti`)" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"isRevoked\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier (`jti`)" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve Semantic CWT credential revocation status", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier (`jti`)" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve the revocation status of a Semantic CWT credential by providing its ID." - }, - "response": [ - { - "name": "Revocation status retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier (`jti`)" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"isRevoked\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique credential identifier (`jti`)" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing Semantic CWT credentials." - }, - { - "name": "JSON credentials management", - "item": [ - { - "name": "Retrieve all credential data", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic?tag=&type=&limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic"], - "query": [ - { - "key": "tag", - "value": "", - "description": "Optional tag to filter on." - }, - { - "key": "type", - "value": "", - "description": "Optional credential type to filter on." - }, - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns all available data for existing credentials:\n- For credentials that were created with the `persist` flag set to `true`, the response contains both the credential and its metadata.\n- For credentials that were created with the persist flag set to `false`, the response only contains the metadata (`id`, `tag`, `credentialStatus`, `issuanceDate`).\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_START\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Credentials data retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic?tag=&type=&limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic"], - "query": [ - { - "key": "tag", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"issuanceDate\": \"\",\n \"credential\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"tag\": \"\",\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"issuanceDate\": \"\",\n \"credential\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"tag\": \"\",\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n }\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic?tag=&type=&limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic"], - "query": [ - { - "key": "tag", - "value": "" - }, - { - "key": "type", - "value": "" - }, - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve credential data", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns all available data for an existing credential that matches the provided ID:\n- For credentials that were created with the `persist` flag set to `true`, the response contains both the credential and its metadata.\n- For credentials that were created with the persist flag set to `false`, the response only contains the metadata (`id`, `tag`, `credentialStatus`, `issuanceDate`)\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_START\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Credential data retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"issuanceDate\": \"\",\n \"credential\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"tag\": \"\",\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete credential data", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes all stored data for an existing credential that matches the provided ID. If the credential is revocable, it will also be permanently revoked.\n\n> Removed credential data cannot be recovered.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_DELETE_START\n* CREDENTIAL_WEB_SEMANTIC_DELETE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_DELETE_FAIL" - }, - "response": [ - { - "name": "Credential deleted and revoked if revocable", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Set credential revocation status", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Sets the revocation status of the credential that matches the provided ID as `true` (revoked) or `false` (unrevoked).\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_START\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_SET_STATUS_FAIL\n" - }, - "response": [ - { - "name": "Revocation status updated", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"isRevoked\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve credential revocation status", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns the revocation status of the credential matching the provided ID.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_START\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Credential status", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"isRevoked\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Credential ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve revocation list", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/revocation-lists/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "revocation-lists", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/core/v1/revocation-lists/` is what you're looking for" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns the revocation list matching the provided ID." - }, - "response": [ - { - "name": "Revocation list retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/revocation-lists/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "revocation-lists", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/core/v1/revocation-lists/` is what you're looking for" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/revocation-lists/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "revocation-lists", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Revocation list ID. This value can be found within the credential you created. Look at the value for `Credential.credential.credentialStatus.id`, the string after `https://tenant.vii.mattr.global/core/v1/revocation-lists/` is what you're looking for" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Create a revocation message payload", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"from\": \"\",\n \"to\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status/notification", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status", - "notification" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the credential whose status has changed." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a message in JWM format that can be used to notify subjects based on their credential revocation status change.\n\nTo send a notification to the Subject DID holder, use the returned payload with the [encrypt](#operation/encryptMessage) and [send](#operation/sendMessage) endpoints.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_START\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_REVOCATION_MESSAGE_PAYLOAD_CREATE_FAIL" - }, - "response": [ - { - "name": "Revocation message payload created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"from\": \"\",\n \"to\": [\n \"\",\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/:id/revocation-status/notification", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - ":id", - "revocation-status", - "notification" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Unique identifier for the credential whose status has changed." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"type\": \"\",\n \"to\": [\n {\n \"string\": \"ullamco aute dolor\"\n },\n {\n \"string\": true\n }\n ],\n \"from\": \"\",\n \"created_time\": \"\",\n \"body\": {\n \"revocationListCredential\": \"\",\n \"revocationListIndex\": \"\",\n \"isRevoked\": \"\"\n }\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing JSON credentials." - }, - { - "name": "mDocs management", - "item": [ - { - "name": "Delete mDoc metadata", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDoc ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes all stored data for an existing mDoc that matches the provided ID.\n\n> Removed credential data cannot be recovered.\n\n### **Analytic events**\n* USER_CREDENTIAL_DELETE_START\n* USER_CREDENTIAL_DELETE_SUCCESS\n* USER_CREDENTIAL_DELETE_FAIL" - }, - "response": [ - { - "name": "mDoc metadata deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDoc ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Invalid id parameter format", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDoc ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:id", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) mDoc ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update mDoc status", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Sets the status of an existing mDoc by providing its `credentialId` and the new status. Status can only be **valid**, **suspended** or **invalid**.\n\nOnce an mDoc's status is updated to **invalid**, it cannot be updated again to any other value.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_SET_START\n* MOBILE_CREDENTIAL_STATUS_SET_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_SET_FAIL" - }, - "response": [ - { - "name": "Credential status updated", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"status\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"status\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve mDoc status", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves the status of an existing mDoc by providing its `credentialId`.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Credential status retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"status\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/:credentialId/status", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - ":credentialId", - "status" - ], - "variable": [ - { - "key": "credentialId", - "value": "", - "description": "(Required) mDoc identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create a Status list configuration", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a Status list configuration, which defines a status list validity periods. mDocs can then be assigned to a specific Status list configuration.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_CREATE_FAIL\n" - }, - "response": [ - { - "name": "Status list configuration created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"docType\": \"\",\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all Status list configurations", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all Status list configurations from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Status list configurations retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"docType\": \"\",\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n },\n {\n \"id\": \"\",\n \"docType\": \"\",\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a Status list configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Status list configuration by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Status list configuration retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"docType\": \"\",\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a Status list configuration", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing Status list configuration, allowing you to adjust the expiry and TTL (Time To Live) settings.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "Status list configuration updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"docType\": \"\",\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"timeToLiveDuration\": \"\",\n \"expiryDuration\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a Status list configuration", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Permanently deletes an existing Status list configuration.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_CONFIGURATION_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Status list configuration deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad request", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/configurations/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "configurations", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Status list configuration ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve all Status lists", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "status-lists"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all existing status lists from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Status lists retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "mobile", "status-lists"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"iacaId\": \"\",\n \"statusListConfigurationId\": \"\",\n \"listSize\": \"\",\n \"list\": \"\"\n },\n {\n \"id\": \"\",\n \"iacaId\": \"\",\n \"statusListConfigurationId\": \"\",\n \"listSize\": \"\",\n \"list\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a Status list", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing Status list and its signed token by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Status list retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"iacaId\": \"\",\n \"statusListConfigurationId\": \"\",\n \"listSize\": \"\",\n \"list\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list unique identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a Status list token", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/cwt" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId", - "token" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves the Status list token in CWT format. This public end point returns a token which contains a compressed, signed list of credential statuses. Relying parties\ncan use this token to check the revocation status of an mDoc that references this Status list.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_START\n* MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_TOKEN_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Status list token retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/cwt" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId", - "token" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "application/cwt" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId", - "token" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - }, - { - "name": "Status list expired", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/:statusListId/token", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - ":statusListId", - "token" - ], - "variable": [ - { - "key": "statusListId", - "value": "", - "description": "(Required) Status list identifier" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Gone", - "code": 410, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Status list distribution", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/distribution", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "distribution" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an object that details all existing Status lists tokens on the tenant. This public endpoint allows a relying party to consume and cache status lists. Each list\nin the response includes a URL where its token can be retrieved. Status list tokens that were signed by expired IACAs are excluded from the response.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_START\n* MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_SUCCESS\n* MOBILE_CREDENTIAL_STATUS_LIST_DISTRIBUTION_FAIL\n" - }, - "response": [ - { - "name": "Status lists retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/status-lists/distribution", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "status-lists", - "distribution" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"status_lists\": {\n \"uri\": \"\"\n }\n },\n {\n \"status_lists\": {\n \"uri\": \"\"\n }\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing mDocs credentials." - } - ] - }, - { - "name": "Credential verification", - "item": [ - { - "name": "CWT credentials verification", - "item": [ - { - "name": "Verify a CWT credential", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "file", - "src": [] - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Verify a CWT credential by providing the encoded payload and specifying verification options.\n\nYou can provide a valid CWT credential as either an encoded string or a QR code in a PDF document or an image file.\n\nStandard checks performed on all verification requests:\n- Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`.\n- Decoded payload structure is a valid CWT credential.\n- Issuer DID can be used to resolve its `did.json` document.\n- Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with.\n\nOptional parameter checks:\n- Credential was issued by a trusted issuer.\n- Current time is after the beginning of the credential validity period.\n- Current time is not after the end of the credential validity period.\n- Credential has not been revoked.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_VERIFY_START\n* CREDENTIAL_COMPACT_VERIFY_SUCCESS\n* CREDENTIAL_COMPACT_VERIFY_FAIL" - }, - "response": [ - { - "name": "Verification completed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verified\": \"\",\n \"decoded\": {\n \"iss\": \"\",\n \"jti\": \"\",\n \"nbf\": \"\",\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"type\": \"\",\n \"status\": {\n \"url\": \"\",\n \"index\": \"\"\n }\n },\n \"error\": {\n \"type\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Payload Too Large", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Request Entity Too Large", - "code": 413, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Unsupported Media Type", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image:\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Unsupported Media Type", - "code": 415, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Specifies paths and operations for verifying CWT credentials." - }, - { - "name": "Semantic CWT credentials verification", - "item": [ - { - "name": "Verify a Semantic CWT credential", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "multipart/form-data" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "file", - "src": [] - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "compact-semantic", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Verify a Semantic CWT credential by providing the encoded payload and specifying verification options.\n\nYou can provide a valid Semantic CWT credential as either an encoded string or a QR code in a PDF document or an image file.\n\nStandard checks performed on all verification requests:\n- Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`.\n- Decoded payload CWT structure and attributes can be validated.\n- Remote context schema can be resolved and validate claims can be dereferenced.\n- Issuer DID can be used to resolve its `did.json` document.\n- Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with.\n\nOptional parameter checks:\n- Credential was issued by a trusted issuer.\n- Current time is after the beginning of the credential validity period.\n- Current time is not after the end of the credential validity period.\n- Credential has not been revoked.\n\n### **Analytic events**\n* CREDENTIAL_COMPACT_SEMANTIC_VERIFY_START\n* CREDENTIAL_COMPACT_SEMANTIC_VERIFY_SUCCESS\n* CREDENTIAL_COMPACT_SEMANTIC_VERIFY_FAIL" - }, - "response": [ - { - "name": "Verification completed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verified\": \"\",\n \"decoded\": {\n \"iss\": \"\",\n \"nbf\": \"\",\n \"jti\": \"\",\n \"vc\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"credentialSubject\": {\n \"eu_95\": \"\",\n \"incididuntf\": \"\",\n \"deserunt_b\": \"\"\n }\n },\n \"exp\": \"\",\n \"iat\": \"\",\n \"aud\": \"\",\n \"sub\": \"\",\n \"status\": {\n \"url\": \"\",\n \"index\": \"\"\n }\n },\n \"error\": {\n \"type\": \"\",\n \"message\": \"\",\n \"details\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Payload Too Large", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Request Entity Too Large", - "code": 413, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Unsupported Media Type", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "value": "", - "description": "(Required) A PDF or an image\n- File size can be 1MB or under. Larger files are rejected with a 413 error. \n- Only the first page of PDF documents is processed.  \n- Image files must contain a QR code of sufficient quality and resolution. This depends on many factors such as the size of the QR relative to the image, and whether the image had been processed in any way.\n- For optimal performance, ensure that only a single QR code is present on the file. ", - "type": "text" - }, - { - "key": "trustedIssuers", - "value": "[\"\",\"\"]", - "description": "When you include issuers' DIDs in this array, credentials will only be verified if their `iss` value matches one of these DIDs. You can include multiple trusted issuers, separated by commas.", - "type": "text" - }, - { - "key": "assertValidFrom", - "value": "true", - "description": "MATTR VII validates the credential's `nbf` (not before) field by default, so that credentials that have a future `nbf` date will not be verified. When this field is set to `false`, credentials can be verified even when their `nbf` date is in the future.", - "type": "text" - }, - { - "key": "assertValidUntil", - "value": "true", - "description": "MATTR VII validates the credential's `exp` (expiry) field by default, so that expired credentials will not be verified. When this field is set to `false`, credentials can be verified even when their `exp` date has passed.", - "type": "text" - }, - { - "key": "checkRevocation", - "value": "true", - "description": "MATTR VII checks the credential revocation status by default, so that revoked credentials will not be verified. When this field is set to `false`, credentials can be verified even when they had been revoked.", - "type": "text" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/compact-semantic/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "compact-semantic", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Unsupported Media Type", - "code": 415, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - } - ] - } - ], - "description": "Specifies paths and operations for verifying Semantic CWT credentials." - }, - { - "name": "JSON credentials verification", - "item": [ - { - "name": "Verify a JSON credential", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"@context\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"checkRevocation\": true,\n \"assertValidFrom\": true,\n \"assertValidUntil\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Verify a JSON credential by providing its payload. The credential is verified against the following criteria:\n- Issuer DID can be resolved, so that the referenced DID Document is available and valid and the public key is obtainable.\n- Proof is valid and the credential has not been tampered with.\n- JSON-LD context is valid for subject claims.\n\nOptional verification checks:\n- If `assertExpiry` is set to `true` and the credential has a set expiration date, verification will fail if the expiration date has passed.\n- If `checkRevocation` is set to `true` and the provided credential contains a revocation status list, verification will fail if the credential has been set to `revoked`.\n\n### **Analytic events**\n* CREDENTIAL_WEB_SEMANTIC_VERIFY_START\n* CREDENTIAL_WEB_SEMANTIC_VERIFY_SUCCESS\n* CREDENTIAL_WEB_SEMANTIC_VERIFY_FAIL" - }, - "response": [ - { - "name": "Verification completed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"@context\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"checkRevocation\": true,\n \"assertValidFrom\": true,\n \"assertValidUntil\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verified\": \"\",\n \"reason\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"payload\": {\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"@context\": [\n \"\",\n \"\"\n ],\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n },\n \"checkRevocation\": true,\n \"assertValidFrom\": true,\n \"assertValidUntil\": false\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/verify", - "host": ["{{baseUrl}}"], - "path": ["v2", "credentials", "web-semantic", "verify"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Create a presentation template", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a presentation template defining what type of credential is required for a particular verification workflow. Presentation templates are used to create presentation requests that are shared with a specific holder.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_CREATE_FAIL" - }, - "response": [ - { - "name": "Presentation template created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all presentation templates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all presentation templates on your tenant.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Presentation templates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n },\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n },\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n },\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n },\n {\n \"@context\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": {\n \"value\": \"\"\n }\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a presentation template", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieve an existing presentation template by its ID.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Presentation template retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a presentation template", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing presentation template by its ID.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_DELETE_FAIL" - }, - "response": [ - { - "name": "Presentation template deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update a presentation template", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ],\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing presentation template by its ID.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_START\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_TEMPLATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "OK", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"@context\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"type\": {\n \"value\": \"\"\n },\n \"trustedIssuer\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ],\n \"id\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/templates/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "templates", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Presentation template ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"type\": \"\",\n \"trustedIssuer\": [\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n },\n {\n \"required\": {\n \"value\": \"\"\n },\n \"issuer\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ]\n}" - } - ] - }, - { - "name": "Create a presentation request", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"challenge\": \"\",\n \"templateId\": \"\",\n \"did\": \"\",\n \"callbackUrl\": \"\",\n \"expiresTime\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/requests", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "requests" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a short lived presentation request based on an existing presentation template. The request is returned in the form of a JWM message and must be [signed](#operation/signMessage) and sent to the holder via one of the following methods:\n- QR code.\n- Deeplink.\n- [Encrypted](#operation/encryptMessage) and [sent](#operation/sendMessage) as a wallet notification.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_START\n* PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_REQUEST_CREATE_FAIL" - }, - "response": [ - { - "name": "Presentation request created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"challenge\": \"\",\n \"templateId\": \"\",\n \"did\": \"\",\n \"callbackUrl\": \"\",\n \"expiresTime\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/requests", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "requests" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"callbackUrl\": \"\",\n \"request\": {\n \"id\": \"\",\n \"type\": \"\",\n \"from\": \"\",\n \"created_time\": \"\",\n \"expires_time\": \"\",\n \"reply_url\": \"\",\n \"reply_to\": [\n \"\",\n \"\"\n ],\n \"body\": {\n \"id\": \"\",\n \"domain\": \"\",\n \"name\": \"\",\n \"query\": [\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reason\": \"\"\n }\n ]\n },\n {\n \"type\": \"\",\n \"credentialQuery\": [\n {\n \"required\": \"\",\n \"example\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"reason\": \"\"\n }\n ]\n }\n ],\n \"challenge\": \"\"\n }\n },\n \"didcommUri\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"challenge\": \"\",\n \"templateId\": \"\",\n \"did\": \"\",\n \"callbackUrl\": \"\",\n \"expiresTime\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/requests", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "requests" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Verify a verifiable presentation", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"presentation\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"verifiableCredential\": [\n {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"\",\n \"holder\": \"\",\n \"proof\": [\n {\n \"type\": \"\",\n \"created\": \"\",\n \"challenge\": \"\",\n \"domain\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n }\n ]\n },\n \"challenge\": \"\",\n \"domain\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Verifies a provided verifiable presentation that adheres to the [W3C Verifiable Credential Data Model](https://www.w3.org/TR/vc-data-model/#presentations):\n- Ensures the presentation conforms to the VC Data model.\n- For each `verifiableCredential` objects:\n - Issuer DID can be resolved.\n - JSON-LD context is valid for subject claims.\n - Proof is valid & the credential has not been tampered with.\n - Is not in a `revoked` status on a `RevocationList2020`.\n - The proof is valid for each subjectDID to prove ownership.\n - Valid proof exists for the presentation `holderDID`.\n\nThe request must include a `presentation` object that adheres to the [W3C Verifiable Credential Data Model](https://www.w3.org/TR/vc-data-model/#presentations).\n\nIf a `challenge` and/or `domain` is provided they are used for credential verification. Otherwise, the `challenge` and/or `domain` within the presentation proof is used instead.\n\n### **Analytic events**\n* PRESENTATION_WEB_SEMANTIC_VERIFY_START\n* PRESENTATION_WEB_SEMANTIC_VERIFY_SUCCESS\n* PRESENTATION_WEB_SEMANTIC_VERIFY_FAIL" - }, - "response": [ - { - "name": "Presentation verification completed", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"presentation\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"verifiableCredential\": [\n {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"\",\n \"holder\": \"\",\n \"proof\": [\n {\n \"type\": \"\",\n \"created\": \"\",\n \"challenge\": \"\",\n \"domain\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n }\n ]\n },\n \"challenge\": \"\",\n \"domain\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verified\": \"\",\n \"reason\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"presentation\": {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"verifiableCredential\": [\n {\n \"@context\": [\n \"\",\n \"\"\n ],\n \"type\": [\n \"\",\n \"\"\n ],\n \"issuanceDate\": \"\",\n \"credentialSubject\": {\n \"givenName\": \"\",\n \"familyName\": \"\",\n \"alumniOf\": \"\"\n },\n \"proof\": {\n \"type\": \"\",\n \"created\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n },\n \"issuer\": {\n \"id\": \"\",\n \"name\": \"\",\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"credentialBranding\": {\n \"backgroundColor\": \"\",\n \"watermarkImageUrl\": \"\"\n },\n \"credentialStatus\": {\n \"id\": \"\",\n \"type\": \"\",\n \"revocationListIndex\": \"\",\n \"revocationListCredential\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"id\": \"\",\n \"holder\": \"\",\n \"proof\": [\n {\n \"type\": \"\",\n \"created\": \"\",\n \"challenge\": \"\",\n \"domain\": \"\",\n \"jws\": \"\",\n \"proofPurpose\": \"\",\n \"verificationMethod\": \"\"\n }\n ]\n },\n \"challenge\": \"\",\n \"domain\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/web-semantic/presentations/verify", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "web-semantic", - "presentations", - "verify" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for verifying JSON credentials." - }, - { - "name": "mDocs verification", - "item": [ - { - "name": "Trusted issuers", - "item": [ - { - "name": "Create a trusted issuer", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"certificatePem\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Add a new mDocs trusted issuer, to be used in online presentation workflows.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_CREATE_FAIL\n" - }, - "response": [ - { - "name": "Trusted issuer created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"certificatePem\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"certificatePem\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers" - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all trusted issuers", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers" - ], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all mDocs trusted issuers from your tenant.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "Trusted issuers retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve a trusted issuer", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing trusted issuer from your tenant by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_RETRIEVE_FAIL\n" - }, - "response": [ - { - "name": "Trusted issuer retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateData\": {\n \"notAfter\": \"\",\n \"notBefore\": \"\",\n \"country\": \"\",\n \"commonName\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a trusted issuer", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing trusted issuer by providing its ID.\n\n### **Analytic events**\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_START\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_SUCCESS\n* MOBILE_CREDENTIAL_TRUSTED_ISSUER_DELETE_FAIL\n" - }, - "response": [ - { - "name": "Trusted issuer deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/credentials/mobile/trusted-issuers/:id", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "credentials", - "mobile", - "trusted-issuers", - ":id" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Trusted issuer ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ] - }, - { - "name": "Verifier root CA certificates", - "item": [ - { - "name": "Create a verifier root CA certificate", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"\",\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "certificates", "ca"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a verifier root CA certificate to be used as part of mDocs online verification workflows.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_CREATE_FAIL" - }, - "response": [ - { - "name": "Verifier root CA certificate created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"\",\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "certificates", "ca"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateData\": {\n \"commonName\": \"\",\n \"country\": \"\",\n \"notAfter\": \"\",\n \"notBefore\": \"\"\n },\n \"active\": true\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"commonName\": \"{tenantDomain} Verifier\",\n \"country\": \"\",\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "certificates", "ca"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all verifier root CA certificates", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "certificates", "ca"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all existing verifier root CA certificates.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Verifier root CA certificates retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "certificates", "ca"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateData\": {\n \"commonName\": \"\",\n \"country\": \"\",\n \"notAfter\": \"\",\n \"notBefore\": \"\"\n },\n \"active\": true\n },\n {\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateData\": {\n \"commonName\": \"\",\n \"country\": \"\",\n \"notAfter\": \"\",\n \"notBefore\": \"\"\n },\n \"active\": true\n }\n ],\n \"nextCursor\": \"\"\n}" - } - ] - }, - { - "name": "Update a verifier root CA certificate", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing verifier root CA certificate.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_UPDATE_FAIL" - }, - "response": [ - { - "name": "Verifier root CA certificate updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateData\": {\n \"commonName\": \"\",\n \"country\": \"\",\n \"notAfter\": \"\",\n \"notBefore\": \"\"\n },\n \"active\": true\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"active\": true\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a verifier root CA certificate", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing verifier root CA certificate.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_CA_CERTIFICATE_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Verifier root CA certificate retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"certificatePem\": \"\",\n \"certificateFingerprint\": \"\",\n \"certificateData\": {\n \"commonName\": \"\",\n \"country\": \"\",\n \"notAfter\": \"\",\n \"notBefore\": \"\"\n },\n \"active\": true\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a verifier root CA certificate", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing verifier root CA certificate.\n\n### **Analytic events**\n* PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_START\n* PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_SUCCESS\n* PRESENTATION_VERIFIER_CA_CERTIFICATE_DELETE_FAIL" - }, - "response": [ - { - "name": "Verifier root CA certificate deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/certificates/ca/:certificateId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "certificates", - "ca", - ":certificateId" - ], - "variable": [ - { - "key": "certificateId", - "value": "", - "description": "(Required) Unique identifier for the verifier root CA certificate." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ] - }, - { - "name": "Verifier applications", - "item": [ - { - "name": "Create verifier application", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "applications"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates an mDocs online verifier application.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_CREATE_FAIL" - }, - "response": [ - { - "name": "Verifier application created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "applications"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"id\": \"\",\n \"additionalDomains\": [\n \"\"\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "applications"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all verifier applications", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "applications"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all configured mDocs online verifier applications.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Verifier applications retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "applications"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "[\n {\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"id\": \"\",\n \"additionalDomains\": [\n \"\"\n ]\n },\n {\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"id\": \"\",\n \"additionalDomains\": [\n \"\"\n ]\n }\n]" - } - ] - }, - { - "name": "Update verifier application", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing mDocs online verifier application.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_UPDATE_FAIL" - }, - "response": [ - { - "name": "Verifier application updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"id\": \"\",\n \"additionalDomains\": [\n \"\"\n ]\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"openid4vpConfiguration\": {\n \"supportedModes\": \"all\",\n \"redirectUris\": [\n \"\"\n ],\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"additionalDomains\": [\n \"\"\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a verifier application", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing mDocs online verifier application.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_VERIFIER_APPLICATION_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Verifier application retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"openid4vpConfiguration\": {\n \"redirectUris\": [\n \"\"\n ],\n \"supportedModes\": \"all\",\n \"display\": {\n \"logoImage\": {\n \"url\": \"\",\n \"altText\": \"\"\n },\n \"headerText\": \"\",\n \"bodyText\": \"\",\n \"privacyPolicyUrl\": \"\",\n \"primaryColorHex\": \"\"\n }\n },\n \"domain\": \"\",\n \"type\": \"\",\n \"name\": \"\",\n \"resultAvailableInFrontChannel\": true,\n \"id\": \"\",\n \"additionalDomains\": [\n \"\"\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a verifier application", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Removes an existing mDocs online verifier application.\n\n### **Analytic events**\n* PRESENTATION_VERIFIER_APPLICATION_DELETE_START\n* PRESENTATION_VERIFIER_APPLICATION_DELETE_SUCCESS\n* PRESENTATION_VERIFIER_APPLICATION_DELETE_FAIL" - }, - "response": [ - { - "name": "Verifier application deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/applications/:applicationId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "applications", - ":applicationId" - ], - "variable": [ - { - "key": "applicationId", - "value": "", - "description": "(Required) Unique identifier for the verifier application." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ] - }, - { - "name": "Wallet providers", - "item": [ - { - "name": "Create wallet provider", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "wallet-providers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_CREATE_FAIL" - }, - "response": [ - { - "name": "Wallet provider created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "wallet-providers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "wallet-providers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all wallet providers", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "wallet-providers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves all existing wallet providers that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_LIST_FAIL" - }, - "response": [ - { - "name": "Wallet providers retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers", - "host": ["{{baseUrl}}"], - "path": ["v2", "presentations", "wallet-providers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n }\n]" - } - ] - }, - { - "name": "Update a wallet provider", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_UPDATE_FAIL" - }, - "response": [ - { - "name": "Wallet provider updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Retrieve a wallet provider", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_WALLET_PROVIDER_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Wallet provider retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"openid4vpConfiguration\": {\n \"authorizationEndpoint\": \"\"\n }\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete a wallet provider", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing wallet provider that can present mDocs for online verification.\n\n### **Analytic events**\n* PRESENTATION_WALLET_PROVIDER_DELETE_START\n* PRESENTATION_WALLET_PROVIDER_DELETE_SUCCESS\n* PRESENTATION_WALLET_PROVIDER_DELETE_FAIL" - }, - "response": [ - { - "name": "Wallet provider deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/wallet-providers/:walletProviderId", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "wallet-providers", - ":walletProviderId" - ], - "variable": [ - { - "key": "walletProviderId", - "value": "", - "description": "(Required) Unique identifier for the wallet provider." - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ] - }, - { - "name": "Retrieve presentation session result", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/sessions/:sessionId/result", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "sessions", - ":sessionId", - "result" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "(Required) Session ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves the result of an online presentation session by providing the session's ID.\n\n### **Analytic events**\n* CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_START\n* CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_SUCCESS\n* CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "Session result retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/sessions/:sessionId/result", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "sessions", - ":sessionId", - "result" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "(Required) Session ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"sessionId\": \"\",\n \"challenge\": \"\",\n \"credentialQuery\": [\n \"\",\n \"\"\n ],\n \"credentials\": [\n {\n \"docType\": \"\",\n \"validityInfo\": {\n \"signed\": \"\",\n \"validFrom\": \"\",\n \"validUntil\": \"\",\n \"expectedUpdate\": \"\"\n },\n \"claims\": \"\",\n \"claimErrors\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"issuerInfo\": {\n \"commonName\": \"\",\n \"trustedIssuerId\": \"\"\n },\n \"verificationResult\": {\n \"verified\": \"\",\n \"reason\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n },\n \"ecosystemValidation\": {\n \"validated\": \"\",\n \"policyVersion\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ],\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n }\n },\n {\n \"docType\": \"\",\n \"validityInfo\": {\n \"signed\": \"\",\n \"validFrom\": \"\",\n \"validUntil\": \"\",\n \"expectedUpdate\": \"\"\n },\n \"claims\": \"\",\n \"claimErrors\": \"\",\n \"branding\": {\n \"name\": \"\",\n \"description\": \"\",\n \"backgroundColor\": \"\",\n \"watermarkImage\": \"\",\n \"issuerLogo\": \"\",\n \"issuerIcon\": \"\"\n },\n \"issuerInfo\": {\n \"commonName\": \"\",\n \"trustedIssuerId\": \"\"\n },\n \"verificationResult\": {\n \"verified\": \"\",\n \"reason\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n },\n \"ecosystemValidation\": {\n \"validated\": \"\",\n \"policyVersion\": \"\",\n \"failReasons\": [\n {\n \"type\": \"\",\n \"message\": \"\"\n },\n {\n \"type\": \"\",\n \"message\": \"\"\n }\n ],\n \"error\": {\n \"type\": \"\",\n \"message\": \"\"\n }\n }\n }\n ],\n \"credentialErrors\": [\n {\n \"docType\": \"\",\n \"errorCode\": \"\"\n },\n {\n \"docType\": \"\",\n \"errorCode\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/v2/presentations/sessions/:sessionId/result", - "host": ["{{baseUrl}}"], - "path": [ - "v2", - "presentations", - "sessions", - ":sessionId", - "result" - ], - "variable": [ - { - "key": "sessionId", - "value": "", - "description": "(Required) Session ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for verifying mDocs credentials." - } - ] - }, - { - "name": "OIDC Bridge verification", - "item": [ - { - "name": "OIDC Verifier Auth", - "item": [ - { - "name": "Well Known OpenId Configuration", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/.well-known/openid-configuration", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - ".well-known", - "openid-configuration" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "The standard OpenID Connect Well Known configuration metadata endpoint.\n\nThis endpoint is unprotected, public facing and can be used by any party wishing to discover the OpenID Connect capabilities.\n" - }, - "response": [ - { - "name": "Returns OpenID configuration", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/.well-known/openid-configuration", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - ".well-known", - "openid-configuration" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"authorization_endpoint\": \"\",\n \"claims_parameter_supported\": \"\",\n \"claims_supported\": [\n \"\",\n \"\"\n ],\n \"code_challenge_methods_supported\": [\n \"\",\n \"\"\n ],\n \"end_session_endpoint\": \"\",\n \"grant_types_supported\": [\n \"\",\n \"\"\n ],\n \"id_token_signing_alg_values_supported\": [\n \"\",\n \"\"\n ],\n \"issuer\": \"\",\n \"jwks_uri\": \"\",\n \"registration_endpoint\": \"\",\n \"request_object_signing_alg_values_supported\": [\n \"\",\n \"\"\n ],\n \"request_parameter_supported\": \"\",\n \"request_uri_parameter_supported\": \"\",\n \"require_request_uri_registration\": \"\",\n \"response_modes_supported\": [\n \"\",\n \"\"\n ],\n \"response_types_supported\": [\n \"\",\n \"\"\n ],\n \"scopes_supported\": [\n \"\",\n \"\"\n ],\n \"subject_types_supported\": [\n \"\",\n \"\"\n ],\n \"token_endpoint_auth_methods_supported\": [\n \"\",\n \"\"\n ],\n \"token_endpoint_auth_signing_alg_values_supported\": [\n \"\",\n \"\"\n ],\n \"token_endpoint\": \"\",\n \"userinfo_endpoint\": \"\",\n \"userinfo_signing_alg_values_supported\": [\n \"\",\n \"\"\n ],\n \"claim_types_supported\": [\n \"\",\n \"\"\n ]\n}" - } - ] - }, - { - "name": "Retrieve Token", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/x-www-form-urlencoded" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_secret", - "value": "" - }, - { - "key": "grant_type", - "value": "" - }, - { - "key": "code", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/token", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id", "token"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "> OIDC Token endpoint\n\nThe OpenId Connect `/token` endpoint is used to obtain the `access_token` and `id_token` by presenting a valid authorization `code`\n\n### **Analytic events**\n* OIDC_VERIFIER_AUTH_START\n* OIDC_VERIFIER_AUTH_SUCCESS\n* OIDC_VERIFIER_AUTH_FAIL" - }, - "response": [ - { - "name": "OK", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_secret", - "value": "" - }, - { - "key": "grant_type", - "value": "" - }, - { - "key": "code", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/token", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "token" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"access_token\": \"\",\n \"token_type\": \"\",\n \"refresh_token\": \"\",\n \"expires_in\": \"\",\n \"id_token\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "urlencoded", - "urlencoded": [ - { - "key": "client_secret", - "value": "" - }, - { - "key": "grant_type", - "value": "" - }, - { - "key": "code", - "value": "" - }, - { - "key": "redirect_uri", - "value": "" - } - ] - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/token", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "token" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for retrieving information required for OIDC bridge verification workflows." - }, - { - "name": "OIDC Verifiers", - "item": [ - { - "name": "Create an OIDC Verifier", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Creates a new OIDC Credential Verifier on the tenant.\n\nOnce created, this OIDC Verifier is publicly available on its `/.well-known/openid-configuration` path. The Authorization header is not required as it is intended for OIDC Client applications to resolve.\n\n### **Analytic events**\n* OIDC_VERIFIER_CREATE_START\n* OIDC_VERIFIER_CREATE_SUCCESS\n* OIDC_VERIFIER_CREATE_FAIL\n" - }, - "response": [ - { - "name": "OIDC Verifier created", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"id\": \"\",\n \"includePresentation\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers"], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all OIDC Verifiers", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all OIDC Verifiers on the tenant.\n\n### **Analytic events**\n* OIDC_VERIFIER_RETRIEVE_LIST_START\n* OIDC_VERIFIER_RETRIEVE_LIST_SUCCESS\n* OIDC_VERIFIER_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "OIDC Verifiers retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": {\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"id\": \"\",\n \"includePresentation\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers"], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve an OIDC Verifier", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing OIDC Verifier by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_RETRIEVE_START\n* OIDC_VERIFIER_RETRIEVE_SUCCESS\n* OIDC_VERIFIER_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "OIDC Verifier retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"id\": \"\",\n \"includePresentation\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update an OIDC Verifier", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing OIDC Verifier by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_UPDATE_START\n* OIDC_VERIFIER_UPDATE_SUCCESS\n* OIDC_VERIFIER_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "OIDC Verifier updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"id\": \"\",\n \"includePresentation\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"verifierDid\": \"\",\n \"presentationTemplateId\": \"\",\n \"claimMappings\": [\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n },\n {\n \"jsonLdFqn\": \"\",\n \"oidcClaim\": \"\"\n }\n ],\n \"includePresentation\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an OIDC Verifier", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing OIDC Verifier by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_DELETE_START\n* OIDC_VERIFIER_DELETE_SUCCESS\n* OIDC_VERIFIER_DELETE_FAIL\n" - }, - "response": [ - { - "name": "OIDC Verifier deleted", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "OIDC Verifier not found", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing OIDC Verifiers." - }, - { - "name": "OIDC Verifier Client", - "item": [ - { - "name": "Configure an OIDC Client", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id", "clients"], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Configures an OIDC Verifier Client on your tenant.\n\nIn order to verify a credential using an OpenID Connect Authorization Code Flow, you need to set up an OIDC Client application. This is the client that will engage with your configured OIDC Verifier to initiate the verification workflow.\nThere is a list of OIDC Client apps, also known as Relying Party Libraries, on the [OpenID website](https://openid.net/developers/certified/). Pick one which you feel comfortable with.\n\n> When dealing with personal identity information it is strongly recommended to follow the Authorization Code Flow which ensures sensitive data is transmitted via the `/token` endpoint back-channel.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_CREATE_START\n* OIDC_VERIFIER_CLIENT_CREATE_SUCCESS\n* OIDC_VERIFIER_CLIENT_CREATE_FAIL" - }, - "response": [ - { - "name": "OIDC Client configured", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Created", - "code": 201, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"id\": \"\",\n \"secret\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "POST", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve all OIDC Clients", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": ["ext", "oidc", "v1", "verifiers", ":id", "clients"], - "query": [ - { - "key": "limit", - "value": "100", - "description": "Range size of returned list." - }, - { - "key": "cursor", - "value": "", - "description": "Starting point for the list of entries." - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Returns a list of all OIDC Verifier Clients on the Tenant.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_START\n* OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_SUCCESS\n* OIDC_VERIFIER_CLIENT_RETRIEVE_LIST_FAIL\n" - }, - "response": [ - { - "name": "OIDC Clients retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"nextCursor\": \"\",\n \"data\": {\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"id\": \"\",\n \"secret\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n }\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients?limit=100&cursor=", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients" - ], - "query": [ - { - "key": "limit", - "value": "100" - }, - { - "key": "cursor", - "value": "" - } - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) Verifier ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - } - ] - }, - { - "name": "Retrieve an OIDC Client", - "request": { - "method": "GET", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Retrieves an existing OIDC Verifier Client by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_RETRIEVE_START\n* OIDC_VERIFIER_CLIENT_RETRIEVE_SUCCESS\n* OIDC_VERIFIER_CLIENT_RETRIEVE_FAIL" - }, - "response": [ - { - "name": "OIDC Verifier Client retrieved", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"id\": \"\",\n \"secret\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Update an OIDC Client", - "request": { - "method": "PUT", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Updates an existing OIDC Verifier Client by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_UPDATE_START\n* OIDC_VERIFIER_CLIENT_UPDATE_SUCCESS\n* OIDC_VERIFIER_CLIENT_UPDATE_FAIL\n" - }, - "response": [ - { - "name": "OIDC Verifier Client updated", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "OK", - "code": 200, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"id\": \"\",\n \"secret\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "PUT", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "body": { - "mode": "raw", - "raw": "{\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"idTokenSignedResponseAlg\": \"\",\n \"responseTypes\": [\n \"\",\n \"\"\n ],\n \"grantTypes\": [\n \"\",\n \"\"\n ],\n \"tokenEndpointAuthMethod\": \"\",\n \"applicationType\": \"\",\n \"logoUri\": \"\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - }, - { - "name": "Delete an OIDC Client", - "request": { - "method": "DELETE", - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - }, - "description": "Deletes an existing OIDC Verifier Client by providing its ID.\n\n### **Analytic events**\n* OIDC_VERIFIER_CLIENT_DELETE_START\n* OIDC_VERIFIER_CLIENT_DELETE_SUCCESS\n* OIDC_VERIFIER_CLIENT_DELETE_FAIL\n" - }, - "response": [ - { - "name": "OIDC Verifier Client deleted.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "No Content", - "code": 204, - "_postman_previewlanguage": "text", - "header": [ - { - "key": "Content-Type", - "value": "text/plain" - } - ], - "cookie": [], - "body": "" - }, - { - "name": "Bad Request. The request was malformed or missing required parameters.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Bad Request", - "code": 400, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n },\n {\n \"value\": \"\",\n \"msg\": \"\",\n \"param\": \"\",\n \"location\": \"\"\n }\n ]\n}" - }, - { - "name": "Not Found. The specified resource was not found.", - "originalRequest": { - "method": "DELETE", - "header": [ - { - "key": "Authorization", - "value": "Bearer ", - "description": "Added as a part of security scheme: bearer" - }, - { - "key": "Accept", - "value": "application/json" - } - ], - "url": { - "raw": "{{baseUrl}}/ext/oidc/v1/verifiers/:id/clients/:clientId", - "host": ["{{baseUrl}}"], - "path": [ - "ext", - "oidc", - "v1", - "verifiers", - ":id", - "clients", - ":clientId" - ], - "variable": [ - { - "key": "id", - "value": "", - "description": "(Required) OIDC Verifier ID" - }, - { - "key": "clientId", - "value": "", - "description": "(Required) OIDC Verifier Client ID" - }, - { - "key": "tenantName", - "value": "{{tenantName}}", - "description": "The tenant subdomain assigned when the tenant was established." - }, - { - "key": "region", - "value": "{{region}}", - "description": "The tenant region assigned when the tenant was established. (This can only be one of au01,ca01,eu01,us01)" - } - ] - } - }, - "status": "Not Found", - "code": 404, - "_postman_previewlanguage": "json", - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "cookie": [], - "body": "{\n \"code\": \"\",\n \"type\": \"\",\n \"message\": \"\"\n}" - } - ] - } - ], - "description": "Specifies paths and operations for managing OIDC Verifier Clients." - } - ] - } - ], - "auth": { - "type": "bearer", - "bearer": [ - { - "key": "token", - "value": "{{bearerToken}}", - "type": "string" - } - ] - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "packages": {}, - "exec": [ - "const tokenUrl = pm.environment.get('auth_url') + '/oauth/token';", - "", - "const clientId = pm.environment.get('auth_client_id');", - "const clientSecret = pm.environment.get('auth_client_secret');", - "", - "const echoPostRequest = {", - " url: tokenUrl,", - " method: 'POST',", - " header: 'Content-Type:application/json',", - " body: {", - " mode: 'application/json',", - " raw: JSON.stringify(", - " {", - " \tclient_id: clientId,", - " \tclient_secret: clientSecret,", - " \taudience: pm.environment.get('auth_audience'),", - " \tgrant_type:'client_credentials'", - " })", - " }", - "};", - "", - "var getToken = true;", - "", - "if (!pm.environment.get('accessTokenExpiry') || ", - " !pm.environment.get('bearerToken')) {", - " console.log('Token or expiry date are missing')", - "} else if (pm.environment.get('accessTokenExpiry') <= (new Date()).getTime()) {", - " console.log('Token is expired')", - "} else {", - " getToken = false;", - " console.log('Token and expiry date are all good');", - "}", - "", - "if (getToken === true) {", - " pm.sendRequest(echoPostRequest, function (err, res) {", - " console.log(err ? err : res.json());", - " if (err === null) {", - " console.log('Saving the token and expiry date')", - " var responseJson = res.json();", - " pm.environment.set('bearerToken', responseJson.access_token)", - " ", - " var expiryDate = new Date();", - " expiryDate.setSeconds(expiryDate.getSeconds() + responseJson.expires_in);", - " pm.environment.set('accessTokenExpiry', expiryDate.getTime());", - " }", - " });", - "}" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "packages": {}, - "exec": [""] - } - } - ], - "variable": [ - { - "key": "tenantName", - "value": "example", - "type": "any" - }, - { - "key": "region", - "value": "au01", - "type": "any" - }, - { - "key": "baseUrl", - "value": "https://{{tenantName}}.vii.{{region}}.mattr.global", - "type": "string" - }, - { - "key": "oauth-token-Url", - "value": "https://auth.au01.mattr.global", - "type": "string" - } - ] -}