QueryRestBearerAuth

Make RESTful request to an endpoint with BearerAuth

Added in version 1.0.0.

Friendly name: QueryRest: BearerAuth
Step class: base_steps_syncpack.steps.QueryRestBearerAuth.QueryRestBearerAuth
Step version: 1.0.0
Required parameters: method, prefix_url

Parameters

Name	Type	Required	Default	Description
`bearer_token`	string	no	–	Token for authorization

Required inherited parameters

These are defined on QueryREST but are required here, so a working configuration must set them.

Name	Type	Required	Default	Description
`method`	enum	yes	–	HTTP method to perform Example: `GET`
`prefix_url`	string	yes	–	used with relative_url to create the full URL. Example: `http://host.example.com`

Other inherited parameters

This step also accepts 20 optional parameter(s) inherited from QueryREST.

Every step also accepts the platform parameters common to all steps – see Platform parameters.

Dependencies

Inherits from: QueryRestBearerAuth -> QueryREST -> BaseStep -> Serializable
SyncPack modules: base_steps_syncpack.steps.QueryREST
External packages: ipaascore

Behaviour

Extends QueryREST and adds bearer-token authentication. On construction it blanks the inherited username and password so Basic auth is not applied, then in execute() assigns the token to the session’s Authorization header and delegates to QueryREST.execute().

Outputs

Identical to QueryREST.

Notes

Warning

The token is assigned raw:

self.session.headers["Authorization"] = bearer_token

No Bearer `` prefix is added. If the API expects one, include it in the parameter value — set ``bearer_token to Bearer eyJhb..., not eyJhb.... This is the single most common way to misconfigure this step.

It inherits QueryREST, which is deprecated. For new work prefer GetREST / PostREST with auth_method and a bearer token supplied through headers.
Leaving bearer_token empty is not an error: the step simply sends no Authorization header, and the request usually fails with a 401 instead of a clear configuration error.