{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CreateCompanyApiCredentialResponse",
"title": "CreateCompanyApiCredentialResponse",
"properties": {
"_links": {
"description": "References to resources linked to the API credential.",
"$ref": "#/components/schemas/ApiCredentialLinks"
},
"active": {
"description": "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
"type": "boolean"
},
"allowedIpAddresses": {
"description": "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
"items": {
"type": "string"
},
"type": "array"
},
"allowedOrigins": {
"description": "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
"items": {
"$ref": "#/components/schemas/AllowedOrigin"
},
"type": "array"
},
"apiKey": {
"description": "The API key for the API credential that was created.",
"type": "string"
},
"associatedMerchantAccounts": {
"description": "List of merchant accounts that the API credential has access to.",
"items": {
"type": "string"
},
"type": "array"
},
"clientKey": {
"description": "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
"type": "string"
},
"description": {
"description": "Description of the API credential.",
"maxLength": 50,
"type": "string"
},
"id": {
"description": "Unique identifier of the API credential.",
"type": "string"
},
"password": {
"description": "The password for the API credential that was created.",
"type": "string"
},
"roles": {
"description": "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.",
"items": {
"type": "string"
},
"type": "array"
},
"username": {
"description": "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **[email protected]**.",
"type": "string"
}
},
"required": [
"id",
"username",
"clientKey",
"allowedIpAddresses",
"roles",
"active",
"password",
"apiKey",
"associatedMerchantAccounts"
],
"type": "object"
}