Credential Requests

The following endpoints allow you to manage credential requests for connections and keys. You can create requests, list them, view details, and manage individual credentials within requests.

Create new Credential Request

post
/credential-requests/requests

Creates a new request for Credentials. Supports two flows - flow for new Make users and flow for existing Make users.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body
namestring · max: 255Required

Name of the Request which will be displayed to the End Users who open it.

teamIdnumberRequired

ID of the Team the Credential Request should be bound to.

descriptionstring · max: 512Optional

Description of the Request which will be displayed to the End Users who open it.

providerone ofRequired

Provider information. Either an existing Make user ID or a new user to invite.

or
Responses
chevron-right
200

Credential Request has been created successfully.

application/json
post
/credential-requests/requests
200

Credential Request has been created successfully.

Get Credential Request Detail

get
/credential-requests/requests/{requestId}

Retrieves detail of a single Credential Request.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
requestIdstring · uuidRequired

ID of the Credential Request.

Query parameters
Responses
chevron-right
200

Credential Request detail.

application/json
get
/credential-requests/requests/{requestId}
200

Credential Request detail.

List Credentials for Request

get
/credential-requests/requests/{requestId}/credentials

Retrieves a list of Credentials associated with a Credential Request.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
requestIdstring · uuidRequired

ID of the Credential Request.

Query parameters
Responses
chevron-right
200

List of Credentials for the Request.

application/json
get
/credential-requests/requests/{requestId}/credentials
200

List of Credentials for the Request.

Get Credential Detail

get
/credential-requests/credentials/{credentialId}

Retrieves detail of a single Credential.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
credentialIdstring · uuidRequired

ID of the Credential.

Query parameters
Responses
chevron-right
200

Credential detail.

application/json
get
/credential-requests/credentials/{credentialId}
200

Credential detail.

Decline Credential

post
/credential-requests/credentials/{credentialId}/decline

Declines a credential by setting its state to declined and recording the reason. This endpoint is idempotent and can be used to update the decline reason of an already declined credential.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
credentialIdstring · uuidRequired

ID of the Credential.

Query parameters
Body
reasonstring · min: 1 · max: 2048Optional

The reason why the credential was declined. This will be visible to support teams and helps with troubleshooting.

Responses
chevron-right
200

Credential has been declined successfully.

application/json
post
/credential-requests/credentials/{credentialId}/decline
200

Credential has been declined successfully.

Delete Remote Credential

post
/credential-requests/credentials/{credentialId}/delete-remote

Deletes a credential from the remote platform (Make Web API) and resets its state to pending. The credential can then be re-created through the normal creation flow.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
credentialIdstring · uuidRequired

ID of the Credential.

Query parameters
Responses
chevron-right
200

Credential has been deleted from remote and reset to pending.

application/json
post
/credential-requests/credentials/{credentialId}/delete-remote
200

Credential has been deleted from remote and reset to pending.

Create Action

post
/credential-requests/actions/create

Creates a new Action for a Credential Creation. Either 'connection' or 'key' must be provided in the request body, but not both.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

Request body for creating a new action for credential creation.

namestring · max: 255Optional

Name of the Request which will be displayed to the End Users who open it.

descriptionstring · max: 512Optional

Description of the Request which will be displayed to the End Users who open it.

Responses
chevron-right
200

Credential Request to be used for completing the Action.

application/json
post
/credential-requests/actions/create
200

Credential Request to be used for completing the Action.

Last updated