Skip to content

[DO NOT MERGE] Adding claims parameter to GetTokenOptions #13595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
schaabs wants to merge 2 commits into from
Closed

[DO NOT MERGE] Adding claims parameter to GetTokenOptions #13595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b010dd5
Adding claims parameter to GetTokenOptions
Feb 4, 2021
78eeb54
Update core-auth.api.md
sadasant Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/core/core-auth/review/core-auth.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export class AzureSASCredential implements SASCredential {
// @public
export interface GetTokenOptions {
abortSignal?: AbortSignalLike;
claims?: string;
requestOptions?: {
timeout?: number;
};
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-auth/src/tokenCredential.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ export interface TokenCredential {
* Defines options for TokenCredential.getToken.
*/
export interface GetTokenOptions {
/**
* Additional claims to be included in the token. See {@link https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter} for more information on format and content.
*/
claims?: string;
Copy link
Copy Markdown
Contributor

@ramya-rao-a ramya-rao-a Feb 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since CAE has been pushed out of the current milestone, am guessing this is not needed for the Feb release? @sadasant Let's make sure @azure/core-auth is released before merging this PR

Copy link
Copy Markdown
Contributor

@sadasant sadasant Feb 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if this needs to be released or not. It seemed like it needed to be released. @schaabs please confirm.

Copy link
Copy Markdown
Author

@schaabs schaabs Feb 4, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It needs to be released before we can release any CAE support in core-http or identity. So it doesn't have to be released now, but if not we'll need to include this with our out of band releases for CAE support. All that said, I don't see any harm in releasing it now.

/**
* The signal which can be used to abort requests.
*/
Expand Down