ApiExternalAccount Data Model

Represents an instantiation of an external account type, referencing a supported external account type, via the typeName field, along with suitable configuration to access an external resource of the provided type. The typeName field must match the name of an external account type.

Properties
name data type description
name string Represents the intial name of the account; used to uniquely identify this account.
displayName string Represents a modifiable label to identify this account for user-visible purposes.
createdTime string Represents the time of creation for this account.
lastModifiedTime string Represents the last modification time for this account.
typeName string Represents the Type ID of a supported external account type. The type represented by this field dictates which configuration options must be defined for this account.
accountConfigs ApiConfigList Represents the account configuration for this account. When an account is retrieved from the server, the configs returned must match allowed configuration for the type of this account. When specified for creation of a new account or for the update of an existing account, this field must include every required configuration parameter specified in the type's definition, with the account configuration's value field specified to represent the specific configuration desired for this account.

Example

{
  "name" : "...",
  "displayName" : "...",
  "createdTime" : "...",
  "lastModifiedTime" : "...",
  "typeName" : "...",
  "accountConfigs" : {
    "items" : [ {
      "name" : "...",
      "value" : "...",
      "required" : true,
      "default" : "...",
      "displayName" : "...",
      "description" : "...",
      "relatedName" : "...",
      "sensitive" : true,
      "validationState" : "OK",
      "validationMessage" : "...",
      "validationWarningsSuppressed" : true
    }, {
      "name" : "...",
      "value" : "...",
      "required" : true,
      "default" : "...",
      "displayName" : "...",
      "description" : "...",
      "relatedName" : "...",
      "sensitive" : true,
      "validationState" : "OK",
      "validationMessage" : "...",
      "validationWarningsSuppressed" : true
    } ]
  }
}