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

Enhancement: Extend graph subscription add with additional options #6158

Open
Jwaegebaert opened this issue Jul 19, 2024 · 3 comments · May be fixed by #6395
Open

Enhancement: Extend graph subscription add with additional options #6158

Jwaegebaert opened this issue Jul 19, 2024 · 3 comments · May be fixed by #6395
Assignees
Labels

Comments

@Jwaegebaert
Copy link
Contributor

Jwaegebaert commented Jul 19, 2024

The POST v1.0/subscriptions endpoint supports more options than we currently have. So the idea is to include these as new options.

Options

Option Description
--lifecycleNotificationUrl [lifecycleNotificationUrl] The URL of the endpoint that will receive the lifecycle notifications. This URL must use the HTTPS protocol.
--notificationUrlAppId [notificationUrlAppId] The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
--latestTLSVersion [latestTLSVersion] The latest version of TLS that the notification endpoint supports. Allowed values are v1_0, v1_1, v1_2, v1_3. Default is v1_2.
--includeResourceData When set, the change notifications will include the changed resource data.
--encryptionCertificate [encryptionCertificate] A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using includeResourceData.
--encryptionCertificateId [encryptionCertificateId] A custom app-provided identifier to help identify the certificate needed to decrypt resource data.

Remarks

(instead of note, use info admonition)

Note

For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing.

Additional options

More info can be found here: https://learn.microsoft.com/graph/api/resources/subscription?view=graph-rest-1.0#properties

@Jwaegebaert Jwaegebaert added enhancement needs peer review Needs second pair of eyes to review the spec or PR labels Jul 19, 2024
@milanholemans milanholemans added help wanted and removed needs peer review Needs second pair of eyes to review the spec or PR labels Sep 7, 2024
@Adam-it Adam-it added the hacktoberfest Issue perfect for hacktoberfest label Sep 24, 2024
@MartinM85
Copy link
Contributor

Seems like creatorId is read-only

@Jwaegebaert
Copy link
Contributor Author

Good point, then we can drop that option.

@MartinM85
Copy link
Contributor

Can I take it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants