Auth Object

This describes the format of the JSON object for the /auth calls

Authentication Settings define the, for example, OAuth settings required to successfully make an API Call.
Example:

{
      "keys": {
        "client_secret": null, 
        "client_id": null
      }, 
      "meta": {
        "domain": "httpbin.org", 
        "description": null, 
        "created": "2015-09-14T23:19:52.888168Z", 
        "documentation": {
          "keys": null, 
          "docs": null, 
          "apps": null, 
          "provider": null
        }, 
        "last_update": "2015-09-14T23:19:52.888175Z", 
        "owner": "agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM", 
        "tags": [], 
        "name": "Minimal Auth Settings name"
      }, 
      "id": "agxkZXZ-dmlhdGVzdHNyGgsSDVNlcnZpY2VDb25maWcYgICAgKDdjQgM", 
      "settings": {
        "auth_type": "NONE", 
        "custom_variables": {}
      }
    }
NameDescriptionrequired?
metaSee section belowYes
settingsSee section belowYes
keysSee section belowNo

meta

NameDescriptionrequired?
nameName for your referenceYes
tagsList of tags for your referenceNo
descriptionDescription for your referenceNo
ownerID of ownerNo - read only
domainhostname for URLs that use this authenticationNo
documentationSee belowNo

meta.documentation

NameDescriptionrequired?
keysLink to developer keys page in siteNo
docsLink to developer docs for siteNo
appsLink to developer app creation page for siteNo
providerLink to homepage of siteNo

settings

NameDescriptionRequired
auth_typeKind of authentication, one of:
"MANUAL", "BASIC", "OAUTH1", "OAUTH2", "NONE", "OAUTH2_JWS", "OAUTH2_JWT", "AMAZON"
Yes
custom_variablesDictionary of custom variables for use in API callsNo
...Other keys may be added depending on the Authentication Type.No
{
  "access": {
    "keys": false, 
    "org_keys": false, 
    "org_settings": false, 
    "settings": false
  }, 
  "keys": {
    "client_secret": null, 
    "client_id": null
  }, 
  "meta": {
    "domain": "httpbin.org", 
    "description": null, 
    "documentation": {
      "keys": null, 
      "docs": null, 
      "apps": null, 
      "provider": null
    }, 
    "owner": "agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM", 
    "tags": [], 
    "name": "Auth Settings update"
  }, 
  "settings": {
    "auth_type": "OAUTH2_JWT", 
    "authorize_url": "http://httpbin.org/get", 
    "custom_variables": {}
  }
}