Add docs for authorization principal in webhooks. #257
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
|
|
tashian
requested changes
Jul 24, 2023
| @@ -164,6 +164,12 @@ The request will contain the `scepChallenge` provided by the client and the `sce | |||
| Unlike webhooks configured on other provisioners, when a single SCEP provisioner is configured with multiple `SCEPCHALLENGE` webhooks, | |||
| only a single one of the `SCEPCHALLENGE` webhooks needs to indicate the request is allowed for the certificate to be issued. | |||
|
|
|||
| ### Webhooks for Cloud (AWS, Azure, GCP) and X5C Provisioners | |||
There was a problem hiding this comment.
Thanks for adding this. I think, for completeness, people should know which attributes to expect in the webhook request. We should show an example request, or at least the names of attributes for the IID instance ID and the certificate subject.
hslatman
reviewed
Jul 25, 2023
| ### Webhooks for Cloud (AWS, Azure, GCP) and X5C Provisioners | ||
|
|
||
| When signing requests are authorized by one of these provisioners, the request body will also contain the authorizing principal(s) | ||
| from the request. For cloud provisioners, this will be the instance identifier from the [Instance Identity Document](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-identity-documents.html), |
There was a problem hiding this comment.
This may need a link for the other cloud provisioners too.
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.
Name of feature:
Pain or issue this feature alleviates:
Why is this important to the project (if not answered above):
Is there documentation on how to use this feature? If so, where?
In what environments or workflows is this feature supported?
In what environments or workflows is this feature explicitly NOT supported (if any)?
Supporting links/other PRs/issues:
💔Thank you!