Jump to

• Request
• Response

Generate an authorization token

post

/v0/token/gen

The Data Clearinghouse REST API requires a valid authorization token for each API call. An authorization token is valid for 15 minutes. After 15 minutes you can generate a new token with this API or use the refresh API to refresh the current token.

Request

Header Parameters

• Referer:
  An optional header that holds the address of a request for purposes of logging, analytics, and so on.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• clientID(required): string
  The user ID assigned by the Data Clearinghouse administrator.
• clientSecret(required): string
  The password string initially assigned by the Data Clearinghouse administrator.
• onBehalfOfClientID: string
  The ID of another client for whom the current client does work. Valid only if the current client's account is authorized to do so.
• scopes(required): array scopes

{
    "required":[
        "clientID",
        "clientSecret",
        "scopes"
    ],
    "type":"object",
    "properties":{
        "clientID":{
            "type":"string",
            "description":"The user ID assigned by the Data Clearinghouse administrator."
        },
        "clientSecret":{
            "type":"string",
            "description":"The password string initially assigned by the Data Clearinghouse administrator."
        },
        "scopes":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "UPLOAD",
                    "DELETE",
                    "UPDATE",
                    "EXPORT_REDACTED",
                    "EXPORT_NON_REDACTED",
                    "EXPORT_SUMMARIZATION"
                ],
                "description":"A scope is a permission the Data Clearinghouse administrator sets on your account to allow you to perform a specific function. Specify your scopes to associate them with the token."
            }
        },
        "onBehalfOfClientID":{
            "type":"string",
            "description":"The ID of another client for whom the current client does work. Valid only if the current client's account is authorized to do so."
        }
    }
}

Nested Schema : scopes

Type: array

Show Source

• Array of: string
  Allowed Values: [ "UPLOAD", "DELETE", "UPDATE", "EXPORT_REDACTED", "EXPORT_NON_REDACTED", "EXPORT_SUMMARIZATION" ]

  A scope is a permission the Data Clearinghouse administrator sets on your account to allow you to perform a specific function. Specify your scopes to associate them with the token.

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "UPLOAD",
            "DELETE",
            "UPDATE",
            "EXPORT_REDACTED",
            "EXPORT_NON_REDACTED",
            "EXPORT_SUMMARIZATION"
        ],
        "description":"A scope is a permission the Data Clearinghouse administrator sets on your account to allow you to perform a specific function. Specify your scopes to associate them with the token."
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Default response

Body ()

Root Schema : TokenResponse

Type: object

Show Source

• expiration: integer (int64)
  The expiration timecode.
• token: string
  The token string.

{
    "type":"object",
    "properties":{
        "token":{
            "type":"string",
            "description":"The token string."
        },
        "expiration":{
            "type":"integer",
            "format":"int64",
            "description":"The expiration timecode."
        }
    }
}

Back to Top