feat: Adds access token authentication to client #166
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| const configuration: ClientConfiguration = { | ||
| instanceURL: "https://my.octopus.app", | ||
| userAgentApp: "createRequestHeader-tests", | ||
| accessToken: "access-token", |
Check failure
Code scanning / CodeQL
Hard-coded credentials
|
|
||
| expect(headers).toEqual({ | ||
| "Accept-Encoding": "gzip,deflate,compress", | ||
| Authorization: "Bearer access-token", |
Check failure
Code scanning / CodeQL
Hard-coded credentials
dylanlerch
reviewed
Aug 21, 2023
| @@ -12,12 +13,10 @@ export class AxiosAdapter<TResource> implements Adapter<TResource> { | |||
| url: options.url, | |||
| maxContentLength: Infinity, | |||
| maxBodyLength: Infinity, | |||
| // eslint-disable-next-line @typescript-eslint/consistent-type-assertions | |||
There was a problem hiding this comment.
Yeah not sure why they wouldn't have turned up before, as soon as I opened the file it lit up. We have these in a bunch of places across our various typescript codebases where we need them, so I think the disable is fine in an of itself.
dylanlerch
approved these changes
Aug 21, 2023
geofflamrock
changed the title
|
This pull request has been linked to Shortcut Story #54886: Add support for authenticating with access tokens to the Typescript client. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for authenticating to the Octopus API using an access token as a bearer token in the
Authorizationheader, as part of supporting OIDC for connecting to the API.The
apiKeyproperty in theClientConfigurationtype has been made optional, and backward compatibility has been preserved in the handling of headers, such that if none are provided thenX-Octopus-ApiKeywill be passed with an empty string.Note: The intent is to treat this as a minor version bump as the changes are backward compatible.
[sc-54886]