Services Administration

Share to                                                                    

Grant service access to  the environment, or select one or more workspaces where you want to share the service.

Removing Environment or Workspaces access to a service breaks configurations using that service in the removed workspaces.

Service Type                                                                

Specify the type of service you want to connect to. The service type controls what settings are available for the authentication method.

Service types include:

• Authentication: The Authentication service type lets Creators select from a predefined list of services, like OAuth 2.0 Client Credentials Grant, Google Places, Plaid, and so on.

• Encryption: Connect using the GNU Privacy Guard (GPG) encryption method.

• FTP: Connect using a Secure File Transfer Protocol.

Service Protocol + Host

Enter the service's endpoint to connect to Unqork. For example, https://places.googleapis.com/v1/places/

Authentication Method*

The Authentication Method depends on the selected Service Type.

Access Token URL

Enter the URL that provides the OAuth Access Token. For example, https://account-d.docusign.com/oauth/token.

Client ID

Enter the Client ID provided by the service. Here's an example of a Client ID from Okta: 0oa2hl2inow5Uqc6c357.

Client Secret

Enter the Client Secret value provided by the service. Client Secrets commonly use cryptographically-generated values to improve access security.

Scope

Enter the access Scope value. Available scopes are dependent on the service. For example, Slack provides the following scopes: read, write, and history.

Send Client ID/Secret in Body Instead of Header

When set to (checked), it sends the Client ID and Client Secret values in the body of an HTTP request.

Perform Authentication Only

If authentication is valid, the token is sent back immediately.

Enable Token Persistence

When making requests, tokens are valid until their expiration time. At expiration, the token is no longer stored in Unqork's persisted storage. Requests after the expiration time no longer have an active token, and the service will attempt to retrieve a new one. If successful, the request continues and stores the new token.

When set to (checked), this setting minimizes the number of additional authentication requests made and the number of tokens to maintain. It does not determine whether your requests are successful or not.

Refresh Token                                                                                                    

When setting Enable Token Persistence to (checked), the Refresh Token button displays. Click this button when an issue occurs with the connected service or when your token is revoked. Clicking this button refreshes the token so you can continue to make requests.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub.

Access Token URL

Enter the URL that provides the OAuth Access Token. For example, https://account-d.docusign.com/oauth/token.

Client ID

Enter the Client ID provided by the service. Here's an example of a Client ID from Okta: 0oa2hl2inow5Uqc6c357.

Client Secret

Enter the Client Secret value provided by the service. Client Secrets commonly use cryptographically-generated values to improve access security.

Scope

Enter the access Scope value. Available scopes are dependent on the service. For example, Slack provides the following scopes: read, write, and history.

Send Client ID/Secret in Body Instead of Header

When set to (checked), it sends the Client ID and Client Secret values in the body of an HTTP request.

Send authentication body as 'application/json' instead of 'application/x-www-form-urlencoded' (uncommon)

When set to (checked), encodes the authentication body as JSON.

Username

Enter the username used to access the service.

Password

Enter the password used to access the service.

Perform Authentication Only

If authentication is valid, the token is sent back immediately.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub.

Access Token URL

Enter the URL that provides the OAuth Access Token. For example, https://account-d.docusign.com/oauth/token.

Issuer (Client ID)

Enter the Client ID provided by the service. Here's an example of a Client ID from Okta: 0oa2hl2inow5Uqc6c357.

Subject

Enter the principal of the JWT; this is typically the user ID.

Audience

The audience parameter is a list of case-sensitive URLs that cannot contain whitespaces. For example, ["https://api.my-cloud.com/user", "https://some-tenant.my-cloud.com/"].

Scope(s) to access

Enter the access Scope value. Available scopes are dependent on the service. For example, Slack provides the following scopes: read, write, and history.

Token Expires in (seconds)

Set the amount of time before the access token expires, in seconds. For example, to make a token expire in 90 minutes, enter 5400. (There are 5,400 seconds in 90 minutes.)

Default token expiration is 60 minutes.

Signing Algorithm

Specify an algorithm. he most common signing algorithms for JWTs are HS256 (HMAC using SHA256) and RS256 (RSA using SHA256).

For more information on signing algorithm, view this link: https://www.npmjs.com/package/jsonwebtoken#algorithms-supported.

Shared/Private Key

Enter the key used to access the service.

Perform Authentication Only

If authentication is valid, the token is sent back immediately.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub.

Access Token URL

Enter the URL that provides the JWT Access Token. For example, https://account-d.docusign.com/oauth/token.

Client ID

Enter the Client ID provided by the service. Here's an example of a Client ID from Okta: 0oa2hl2inow5Uqc6c357.

Module ID

The module ID associated with this service.

Secret key for user authorization JWT signing

Enter the key used to authorize the JSON Web Token signing.

Encryption key for user authorization header

Enter the encryption key value used to authorize the user.

Certificate Pem

The certificate containing the Private Key.

Private Key Pem

The key contained in the certificate.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub.

Bearer Token

Enter the bearer token value provided by the external service.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub.

Username

Enter the username used to access the service.

Password

Enter the password used to access the service.

Enable SOAP Digital Signature

A SOAP digital signature is a value computed with a cryptographic algorithm. When that value is sent as part of a request, it lets the recipient verify the security and integrity of the incoming data.

To learn how to set up SOAP Digital Signatures, view our Enabling Soap Digital Signatures article in the Doc Hub.

Account SID

Enter the 34-digit String Identifier (SID) key provided by the Twilio resource.

Auth Token

Enter the URL that provides the OAuth Access Token. For example, https://account-d.docusign.com/oauth/token.

Number

Enter the phone number assigned by Twilio to send text messages.

Express Domain

Enter the express domain assigned by Twilio.

Client ID

Enter the Client ID provided by the service. Here's an example of a Client ID from Okta: 0oa2hl2inow5Uqc6c357.

Public Key

Enter the static public_key provided by Plaid.

Newer Plaid accounts might use the Plaid Link setting: https://plaid.com/docs/link/#introduction-to-link.

Client Secret

Enter the Client Secret value provided by the service. Client Secrets commonly use cryptographically-generated values to improve access security.

Environment

Choose which Plaid environment you want to access. Environments include Sandbox, Development, and Production.

For more on environments, view the following Plaid documentation: https://plaid.com/docs/api/#api-host

SOAP Header

Enter a custom value to include in the header of a  SOAP request.

Enable SOAP Digital Signature

A SOAP digital signature is a value computed with a cryptographic algorithm. When that value is sent as part of a request, it lets the recipient verify the security and integrity of the incoming data.

To learn how to set up SOAP Digital Signatures, view our Enabling Soap Digital Signatures article in the Doc Hub.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub.

Username

Enter the username used to access the service.

Password

Enter the password used to access the service.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub

API Key

Enter the API key provided by the Canada Post service.

API Key

Enter the API key provided by the Google Places service.

Access Key ID

Amazon’s Access Key ID is public and can be shared. It can be used with the Secret Access Key to configure authentication.

Secret Access Key

Use your Amazon S3 bucket’s Secret Access Key in association with the Access Key ID to authenticate your bucket.

Region

The supported region of your Amazon S3 bucket.

To learn more about supported Amazon regions, view the following link: Regional and Zonal endpoints for directory buckets - Amazon Simple Storage Service.

Connection String  

Use your Azure connection string, found in your Azure Portal, to authenticate with Azure Blob Storage.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub

API Key

Enter the API key provided by the Hyperscience service.

Enable Mutual TLS

When set to (checked), it enables the mLTS (Mutual Transport Layer Security) certificate selection.

To learn how to add and manage certificates using Certificate Management, view our Certificate Management article in the Doc Hub

HMAC Private Key (Armored)

Enter the Base-64 encoded string HMAC key associated with the service account.

Service Protocol + Host                                                                        

Enter the endpoint address for the service.

Authentication Method*                                                                        

Set Encryption (GPG) or Decryption (GPG) as the service type's authentication method.

Encryption (GPG)                                                                            

Insert the GPG Encryption value.

To learn how to setup an encrypted SFTP , view our How to: Set up GPG Encryption for Files article.

GPG Public Key (Armored)                                                                                

Enter the public key provided by the service that's encrypting the files.

Decryption (GPG)                                                                            

Insert the GPG Decryption value.

To learn how to decrypt a file using GPG Encryption, view our How to: Set up GPG Encryption for Files article.

GPG Private Key (Armored)                                                                                

Enter the private key provided by the service that's decrypting the files.

Authentication Method*                                                                        

Set FTP or SFTP as the service type's authentication method.

To improve security, use the SFTP method. Only use FTP if no other option is available.

Host                                                                        

Enter the FTP/SFTP server or host address.

Port                                                                        

(FTP Only)

For FTP connections, enter the port value. Typical FTP port values are 20 (data port) and 21 (controlled port).

SFTP uses port 22 by default.

Username                                                                        

Enter the username or login value used to access the server.

Password                                                                        

Enter the password value used to access the server.

SFTP connections using SSH keys might not require a password, or they might require both.

SSH Private Key (.pem)

(SFTP Only)

Insert the private key in pem format.

If the key uses the PuTTY (.ppk) file format, convert it to .pem using a conversion tool.

Private Key Passphrase

(SFTP Only)

If your SSH key uses a passphrase, enter it in this field.