Skip to content
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.

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

CC-31568: Extended the warehouse picking guide with the FA OAuth. #2325

Merged

Conversation

abitskil
Copy link
Contributor

@abitskil abitskil added updated PR contains meaningful changes to some document 202400 PR contains document for the upcoming release 202400 labels Nov 15, 2023
@abitskil abitskil changed the title CC-31568: Extended the warehouse picking guide with the FA oauth. CC-31568: Extended the warehouse picking guide with the FA OAuth. Nov 15, 2023
ilyakubanov
ilyakubanov previously approved these changes Nov 20, 2023
{% endinfo_block %}


## 3) Set up configuration
Copy link
Collaborator

Choose a reason for hiding this comment

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

I split this section into subsections. Please make sure the subsection titles are relevant

| PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------|
| AuthorizeResource | Registers the OAuth authorize resource. | | SprykerEco\Glue\AuthorizationPickingAppBackendApi\Plugin\GlueApplication |
| UserAuthCodeOauthRequestGrantTypeConfigurationProviderPlugin | Builds `OauthGrantTypeConfigurationTransfer` from the configuration of AuthorizationCode GrantType data. | | Spryker\Zed\OauthCodeFlow\Communication\Plugin\Oauth |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are AuthorizationCode and GrantType separate code references?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Only the AuthorizationCode.

|-----------------------|--------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| username | string | some@user.com | The username of the Back Office user. |
| password | string | 349dldks239fj93498di | The password of the Back Office user. |
| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

grants what?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Extended the sentence.

| username | string | some@user.com | The username of the Back Office user. |
| password | string | 349dldks239fj93498di | The password of the Back Office user. |
| response_type | string | code | Defines how the authorization server should respond to the client after the resource owner grants. |
| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Provide proper examples. See other parameters as well

Comment on lines 765 to 768
| grant_type | string | authorization_code | Specifies the type of grant requested by the client. In this case, it's the Authorization Code Grant flow. |
| code | string | some-code | The authorization code provided by the OAuth server. |
| client_id | string | the-client-identifier-of-your-app | Public identifier for the client application that is requesting access to a user's resources. |
| code_verifier | string | some-random-string | A random string generated by the client in the Authorization Code Grant flow with PKCE. It's used to verify the identity of the client when exchanging the authorization code for an access token. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Provide the actual examples

@andriitserkovnyi andriitserkovnyi merged commit 75304aa into master Nov 23, 2023
12 of 13 checks passed
@andriitserkovnyi andriitserkovnyi deleted the feature/cc-31691/dev-fa-guide-update-with-oauth-flow branch November 23, 2023 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
202400 PR contains document for the upcoming release 202400 updated PR contains meaningful changes to some document
Development

Successfully merging this pull request may close these issues.

3 participants