Get list of all credentials (GET)

The purpose of this API is to show all the credentials that are already configured.

Call

If you want to check the credentials that were already configured in your platform you can use this API.

It will return a list of all credentials configured.

Payload Organization

  • Page: This field refers to the result page you want to be shown. In other words, the responses for this API are divided into pages that go from 0 to the number of pages needed to show all the records, this parameter allows you to select which page you will have in your response. The default value is page 0.
  • Size: This field refers to the number of records you want to be displayed on each page. In other words, each response consists of 1 page and several records on that page, this parameter allows you to select the number of records that will be displayed per page. The default value is 1000 records per page.

Response:

When successfully executed the API will return the configured credentials:

{
  "content": [
    {
      "resourceGuid": "9106fff2-f42a-46ed-99df-92fecdf4020f",
      "description": "Webhook credential for user creation",
      "authType": "API_KEY"
    },
    {
      "resourceGuid": "f79285ef-4ed1-4737-bcc5-998d861b9db4",
      "description": "Webhook credential for user updates v4",
      "authType": "BASIC"
    }
  ],
  "pageable": "INSTANCE",
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "first": true,
  "sort": {
    "sorted": false,
    "unsorted": true,
    "empty": true
  },
  "number": 0,
  "numberOfElements": 2,
  "size": 2,
  "empty": false
}

API URL:

https://gateway.enterprisealumni.com/api/v2/credential

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.