reference-examples-operation-security-asyncapi.yml.json

{"asyncapi":"3.1.0","info":{"title":"Notifications","version":"1.0.0","description":"This contract defines HTTP Push notification for  application authorization revocation topic"},"channels":{"authRevoke":{"address":"AUTHORIZATION_REVOCATION","messages":{"message":{"$ref":"#/components/messages/message"}}}},"operations":{"sendAuthRevoke":{"action":"send","channel":{"$ref":"#/channels/authRevoke"},"security":[{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"subscribe:auth_revocations":"Scope required for authorization revocation topic"}}},"scopes":["subscribe:auth_revocations"]}],"bindings":{"http":{"method":"POST"}},"messages":[{"$ref":"#/channels/authRevoke/messages/message"}]}},"components":{"schemas":{"AuthorizationRevocationData":{"type":"object","properties":{"eiasToken":{"type":"string","description":"The legacy eiasToken specific to the user"},"revocationDate":{"type":"string","description":"Date and time when the authorization was revoked"},"revokeReason":{"type":"string","enum":["REVOKED_BY_APP","REVOKED_BY_USER","REVOKED_BY_ADMIN","PASSWORD_CHANGE"],"description":"The reason for authorization revocation"},"userId":{"type":"string","description":"The immutable public userId for the user"},"username":{"type":"string","description":"The username for the user."}},"description":"The Authorization Revocation payload."},"MetaData":{"type":"object","properties":{"deprecated":{"type":"boolean","description":"If this is a deprecated schema or topic.","default":"false"},"schemaVersion":{"type":"string","description":"The schema for this topic."},"topic":{"type":"string","description":"Topic subscribed to."}}},"Notification":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthorizationRevocationData"},"eventDate":{"type":"string","description":"The event date associated with this notification in UTC."},"notificationId":{"type":"string","description":"The notification Id."},"publishAttemptCount":{"type":"integer","description":"The number of attempts made to publish this message."},"publishDate":{"type":"string","description":"The message publish date in UTC."}}}},"messages":{"message":{"headers":{"type":"object","properties":{"Content-Type":{"type":"string","enum":["application/json"]},"X-SIGNATURE":{"type":"string","description":"ECC message signature"}}},"payload":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetaData"},"notification":{"$ref":"#/components/schemas/Notification"}}}}},"securitySchemes":{"petstore_auth":{"type":"oauth2","description":"The oauth security descriptions","flows":{"clientCredentials":{"tokenUrl":"https://example.com/api/oauth/dialog","availableScopes":{"subscribe:auth_revocations":"Scope required for authorization revocation topic"}}}}}}}