Web Authorization

An authorization type and credentials suitable for use in an HTTP Authorization header.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: <type> <credentials>

The credentials field is write-only. It is omitted by read operations.

object

An authorization type and credentials suitable for use in an HTTP Authorization header.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: <type> <credentials>

The credentials field is write-only. It is omitted by read operations.

credentials
string

The confidential portion of the Authorization header that follows the type field.

This field is write-only. It is omitted by read operations.

If authorization is required, the credentials value must be provided whenever a File Source is created or modified. An update to a dataset that does not change the File Source may omit the credentials field–the update will preserve the previous value.

maxLength: 1024
minLength: 1
pattern: [\x21-\x7E \t]*
type
string

The authorization scheme.

Usually this is “Bearer” but it could be other values like “Token” or “Basic” etc.

required
maxLength: 50
pattern: [\x21-\x7E \t]*