Name | Type | Description | Notes |
---|---|---|---|
active | kotlin.Boolean | Indicates if the API credential is enabled. Must be set to true to use the credential in your integration. | |
allowedIpAddresses | kotlin.collections.List<kotlin.String> | List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error. | |
clientKey | kotlin.String | Public key used for client-side authentication. The client key is required for Drop-in and Components integrations. | |
id | kotlin.String | Unique identifier of the API credential. | |
roles | kotlin.collections.List<kotlin.String> | List of roles for the API credential. | |
username | kotlin.String | The name of the API credential, for example [email protected]. | |
links | ApiCredentialLinks | [optional] | |
allowedOrigins | kotlin.collections.List<AllowedOrigin> | List containing the allowed origins linked to the API credential. | [optional] |
associatedMerchantAccounts | kotlin.collections.List<kotlin.String> | List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included. | [optional] |
companyName | kotlin.String | Name of the company linked to the API credential. | [optional] |
description | kotlin.String | Description of the API credential. | [optional] |