CreateApiCredentialResponse class abstract

CreateApiCredentialResponse

Properties:

  • links - References to resources linked to the API credential.
  • active - Indicates if the API credential is enabled. Must be set to true to use the credential in your integration.
  • 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.
  • allowedOrigins - List containing the allowed origins linked to the API credential.
  • apiKey - The API key for the API credential that was created.
  • clientKey - Public key used for client-side authentication. The client key is required for Drop-in and Components integrations.
  • description - Description of the API credential.
  • id - Unique identifier of the API credential.
  • password - The password for the API credential that was created.
  • roles - List of roles for the API credential.
  • username - The name of the API credential, for example ws@Company.TestCompany.
Annotations
  • @BuiltValue.new()

Constructors

CreateApiCredentialResponse([void updates(CreateApiCredentialResponseBuilder b)])
factory

Properties

active → bool
Indicates if the API credential is enabled. Must be set to true to use the credential in your integration.
no setter
allowedIpAddresses → BuiltList<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.
no setter
allowedOrigins → BuiltList<AllowedOrigin>?
List containing the allowed origins linked to the API credential.
no setter
apiKey → String
The API key for the API credential that was created.
no setter
clientKey → String
Public key used for client-side authentication. The client key is required for Drop-in and Components integrations.
no setter
description → String?
Description of the API credential.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier of the API credential.
no setter
References to resources linked to the API credential.
no setter
password → String
The password for the API credential that was created.
no setter
roles → BuiltList<String>
List of roles for the API credential.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
username → String
The name of the API credential, for example ws@Company.TestCompany.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(CreateApiCredentialResponseBuilder)) → CreateApiCredentialResponse
Rebuilds the instance.
inherited
toBuilder() → CreateApiCredentialResponseBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<CreateApiCredentialResponse>
no setter