java.lang.Object
- com.adyen.model.management.ApiCredential

public class ApiCredential
extends Object

ApiCredential

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ACTIVE`
`static String`	`JSON_PROPERTY_ALLOWED_IP_ADDRESSES`
`static String`	`JSON_PROPERTY_ALLOWED_ORIGINS`
`static String`	`JSON_PROPERTY_CLIENT_KEY`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_LINKS`
`static String`	`JSON_PROPERTY_ROLES`
`static String`	`JSON_PROPERTY_USERNAME`

Constructor Summary

Constructors
Constructor Description

ApiCredential()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApiCredential`	`active(Boolean active)`
`ApiCredential`	`addAllowedIpAddressesItem(String allowedIpAddressesItem)`
`ApiCredential`	`addAllowedOriginsItem(AllowedOrigin allowedOriginsItem)`
`ApiCredential`	`addRolesItem(String rolesItem)`
`ApiCredential`	`allowedIpAddresses(List<String> allowedIpAddresses)`
`ApiCredential`	`allowedOrigins(List<AllowedOrigin> allowedOrigins)`
`ApiCredential`	`clientKey(String clientKey)`
`ApiCredential`	`description(String description)`
`boolean`	`equals(Object o)`	Return true if this ApiCredential object is equal to o.
`static ApiCredential`	`fromJson(String jsonString)`	Create an instance of ApiCredential given an JSON string
`Boolean`	`getActive()`	Indicates if the API credential is enabled.
`List<String>`	`getAllowedIpAddresses()`	List of IP addresses from which your client can make requests.
`List<AllowedOrigin>`	`getAllowedOrigins()`	List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
`String`	`getClientKey()`	Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication).
`String`	`getDescription()`	Description of the API credential.
`String`	`getId()`	Unique identifier of the API credential.
`ApiCredentialLinks`	`getLinks()`	Get links
`List<String>`	`getRoles()`	List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
`String`	`getUsername()`	The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example ws@Company.TestCompany.
`int`	`hashCode()`
`ApiCredential`	`id(String id)`
`ApiCredential`	`links(ApiCredentialLinks links)`
`ApiCredential`	`roles(List<String> roles)`
`void`	`setActive(Boolean active)`	Indicates if the API credential is enabled.
`void`	`setAllowedIpAddresses(List<String> allowedIpAddresses)`	List of IP addresses from which your client can make requests.
`void`	`setAllowedOrigins(List<AllowedOrigin> allowedOrigins)`	List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
`void`	`setClientKey(String clientKey)`	Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication).
`void`	`setDescription(String description)`	Description of the API credential.
`void`	`setId(String id)`	Unique identifier of the API credential.
`void`	`setLinks(ApiCredentialLinks links)`	links
`void`	`setRoles(List<String> roles)`	List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
`void`	`setUsername(String username)`	The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example ws@Company.TestCompany.
`String`	`toJson()`	Convert an instance of ApiCredential to an JSON string
`String`	`toString()`
`ApiCredential`	`username(String username)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_LINKS
```
public static final String JSON_PROPERTY_LINKS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ACTIVE
```
public static final String JSON_PROPERTY_ACTIVE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ALLOWED_IP_ADDRESSES
```
public static final String JSON_PROPERTY_ALLOWED_IP_ADDRESSES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ALLOWED_ORIGINS
```
public static final String JSON_PROPERTY_ALLOWED_ORIGINS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CLIENT_KEY
```
public static final String JSON_PROPERTY_CLIENT_KEY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ROLES
```
public static final String JSON_PROPERTY_ROLES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_USERNAME
```
public static final String JSON_PROPERTY_USERNAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApiCredential
```
public ApiCredential()
```
- Method Detail
  - links
```
public ApiCredential links(ApiCredentialLinks links)
```
  - getLinks
```
public ApiCredentialLinks getLinks()
```
    Get links
    
    Returns:
    
    links
  - setLinks
```
public void setLinks(ApiCredentialLinks links)
```
    links
    
    Parameters:
    
    links -
  - active
```
public ApiCredential active(Boolean active)
```
  - getActive
```
public Boolean getActive()
```
    Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.
    
    Returns:
    
    active
  - setActive
```
public void setActive(Boolean active)
```
    Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.
    
    Parameters:
    
    active -
  - allowedIpAddresses
```
public ApiCredential allowedIpAddresses(List<String> allowedIpAddresses)
```
  - addAllowedIpAddressesItem
```
public ApiCredential addAllowedIpAddressesItem(String allowedIpAddressesItem)
```
  - getAllowedIpAddresses
```
public List<String> getAllowedIpAddresses()
```
    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.
    
    Returns:
    
    allowedIpAddresses
  - setAllowedIpAddresses
```
public void setAllowedIpAddresses(List<String> allowedIpAddresses)
```
    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.
    
    Parameters:
    
    allowedIpAddresses -
  - allowedOrigins
```
public ApiCredential allowedOrigins(List<AllowedOrigin> allowedOrigins)
```
  - addAllowedOriginsItem
```
public ApiCredential addAllowedOriginsItem(AllowedOrigin allowedOriginsItem)
```
  - getAllowedOrigins
```
public List<AllowedOrigin> getAllowedOrigins()
```
    List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
    
    Returns:
    
    allowedOrigins
  - setAllowedOrigins
```
public void setAllowedOrigins(List<AllowedOrigin> allowedOrigins)
```
    List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.
    
    Parameters:
    
    allowedOrigins -
  - clientKey
```
public ApiCredential clientKey(String clientKey)
```
  - getClientKey
```
public String getClientKey()
```
    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.
    
    Returns:
    
    clientKey
  - setClientKey
```
public void setClientKey(String clientKey)
```
    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.
    
    Parameters:
    
    clientKey -
  - description
```
public ApiCredential description(String description)
```
  - getDescription
```
public String getDescription()
```
    Description of the API credential.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
    Description of the API credential.
    
    Parameters:
    
    description -
  - id
```
public ApiCredential id(String id)
```
  - getId
```
public String getId()
```
    Unique identifier of the API credential.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
    Unique identifier of the API credential.
    
    Parameters:
    
    id -
  - roles
```
public ApiCredential roles(List<String> roles)
```
  - addRolesItem
```
public ApiCredential addRolesItem(String rolesItem)
```
  - getRoles
```
public List<String> getRoles()
```
    List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
    
    Returns:
    
    roles
  - setRoles
```
public void setRoles(List<String> roles)
```
    List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential.
    
    Parameters:
    
    roles -
  - username
```
public ApiCredential username(String username)
```
  - getUsername
```
public String getUsername()
```
    The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.
    
    Returns:
    
    username
  - setUsername
```
public void setUsername(String username)
```
    The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.
    
    Parameters:
    
    username -
  - equals
```
public boolean equals(Object o)
```
    Return true if this ApiCredential object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static ApiCredential fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of ApiCredential given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of ApiCredential
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ApiCredential
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of ApiCredential to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class ApiCredential

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_LINKS

JSON_PROPERTY_ACTIVE

JSON_PROPERTY_ALLOWED_IP_ADDRESSES

JSON_PROPERTY_ALLOWED_ORIGINS

JSON_PROPERTY_CLIENT_KEY

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_ID

JSON_PROPERTY_ROLES

JSON_PROPERTY_USERNAME

Constructor Detail

ApiCredential

Method Detail

links

getLinks

setLinks

active

getActive

setActive

allowedIpAddresses

addAllowedIpAddressesItem

getAllowedIpAddresses

setAllowedIpAddresses

allowedOrigins

addAllowedOriginsItem

getAllowedOrigins

setAllowedOrigins

clientKey

getClientKey

setClientKey

description

getDescription

setDescription

id

getId

setId

roles

addRolesItem

getRoles

setRoles

username

getUsername

setUsername

equals

hashCode

toString

fromJson

toJson