Sign in

v1

latestSwagger 2.0raw.githubusercontent.com2018-12-0670110154.0 KB
settings

Get information about a client account

Return all the client wide settings of the requested client account

get/clientaccounts/{clientAccount}

Response

The client account

awsSecretValueInfo'EMPTY' | 'POPULATED' | 'POPULATED_PREFIX' | 'POPULATED_SUFFIX' required

Type of sensitive information value when returning results. EMPTY: The value is not populated. POPULATED: The value is populated but it is not returned POPULATED_PREFIX: The value is populated and a sample prefix is returned
POPULATED_SUFFIX: The value is populated and a sample suffix is returned

awsAccessKeyValueInfo'EMPTY' | 'POPULATED' | 'POPULATED_PREFIX' | 'POPULATED_SUFFIX' required

Type of sensitive information value when returning results. EMPTY: The value is not populated. POPULATED: The value is populated but it is not returned POPULATED_PREFIX: The value is populated and a sample prefix is returned
POPULATED_SUFFIX: The value is populated and a sample suffix is returned

mandrillApiKeyValueInfo'EMPTY' | 'POPULATED' | 'POPULATED_PREFIX' | 'POPULATED_SUFFIX' required

Type of sensitive information value when returning results. EMPTY: The value is not populated. POPULATED: The value is populated but it is not returned POPULATED_PREFIX: The value is populated and a sample prefix is returned
POPULATED_SUFFIX: The value is populated and a sample suffix is returned

sendgridApiKeyValueInfo'EMPTY' | 'POPULATED' | 'POPULATED_PREFIX' | 'POPULATED_SUFFIX' required

Type of sensitive information value when returning results. EMPTY: The value is not populated. POPULATED: The value is populated but it is not returned POPULATED_PREFIX: The value is populated and a sample prefix is returned
POPULATED_SUFFIX: The value is populated and a sample suffix is returned

namestring required

The name of the client account

descriptionstring

A description of the client account

emailstring required

Primary e-mail of contact

phonestring

Primary phone of contact

sendgridApiKeystring

Sendgrid API key used for the sendgrid actions

mandrillApiKeystring

Mandrill API key used for the mandrill actions

awsAccessKeystring

AWS access key of the client's account. This is used by any actions that require to the client's customer's account (e.g. SNS Push action)

awsSecretstring

AWS secret that corresponds to the AWS key of the client's account. This is used by any actions that require to the client's customer's account (e.g. SNS Push action)

awsRegionstring

AWS region that corresponds to the AWS key of the client's account. This is used by any actions that require to the client's customer's account (e.g. SNS Push action)

idstring required

System wide unique identifier of the entity