|
| 1 | +asyncapi: 2.4.0 |
| 2 | +info: |
| 3 | + title: Notifications |
| 4 | + version: 1.0.0 |
| 5 | + description: >- |
| 6 | + This contract defines HTTP Push notification for |
| 7 | + application authorization revocation topic |
| 8 | +channels: |
| 9 | + AUTHORIZATION_REVOCATION: |
| 10 | + subscribe: |
| 11 | + message: |
| 12 | + $ref: '#/components/messages/message' |
| 13 | + bindings: |
| 14 | + http: |
| 15 | + type: request |
| 16 | + method: POST |
| 17 | + headers: |
| 18 | + type: object |
| 19 | + properties: |
| 20 | + Content-Type: |
| 21 | + type: string |
| 22 | + enum: |
| 23 | + - application/json |
| 24 | + security: |
| 25 | + petstore_auth: |
| 26 | + - subscribe:auth_revocations |
| 27 | +components: |
| 28 | + messages: |
| 29 | + message: |
| 30 | + headers: |
| 31 | + type: object |
| 32 | + properties: |
| 33 | + X-SIGNATURE: |
| 34 | + description: ECC message signature |
| 35 | + type: string |
| 36 | + payload: |
| 37 | + type: object |
| 38 | + properties: |
| 39 | + metadata: |
| 40 | + $ref: '#/components/schemas/MetaData' |
| 41 | + notification: |
| 42 | + $ref: '#/components/schemas/Notification' |
| 43 | + schemas: |
| 44 | + MetaData: |
| 45 | + type: object |
| 46 | + properties: |
| 47 | + topic: |
| 48 | + type: string |
| 49 | + description: Topic subscribed to. |
| 50 | + schemaVersion: |
| 51 | + type: string |
| 52 | + description: The schema for this topic. |
| 53 | + deprecated: |
| 54 | + type: boolean |
| 55 | + description: If this is a deprecated schema or topic. |
| 56 | + default: 'false' |
| 57 | + Notification: |
| 58 | + type: object |
| 59 | + properties: |
| 60 | + notificationId: |
| 61 | + type: string |
| 62 | + description: The notification Id. |
| 63 | + eventDate: |
| 64 | + type: string |
| 65 | + description: The event date associated with this notification in UTC. |
| 66 | + publishDate: |
| 67 | + type: string |
| 68 | + description: The message publish date in UTC. |
| 69 | + publishAttemptCount: |
| 70 | + type: integer |
| 71 | + description: The number of attempts made to publish this message. |
| 72 | + data: |
| 73 | + $ref: '#/components/schemas/AuthorizationRevocationData' |
| 74 | + AuthorizationRevocationData: |
| 75 | + type: object |
| 76 | + description: The Authorization Revocation payload. |
| 77 | + properties: |
| 78 | + username: |
| 79 | + type: string |
| 80 | + description: The username for the user. |
| 81 | + userId: |
| 82 | + type: string |
| 83 | + description: The immutable public userId for the user |
| 84 | + eiasToken: |
| 85 | + type: string |
| 86 | + description: The legacy eiasToken specific to the user |
| 87 | + revokeReason: |
| 88 | + type: string |
| 89 | + enum: |
| 90 | + - REVOKED_BY_APP |
| 91 | + - REVOKED_BY_USER |
| 92 | + - REVOKED_BY_ADMIN |
| 93 | + - PASSWORD_CHANGE |
| 94 | + description: The reason for authorization revocation |
| 95 | + revocationDate: |
| 96 | + type: string |
| 97 | + description: Date and time when the authorization was revoked |
| 98 | + securitySchemes: |
| 99 | + petstore_auth: |
| 100 | + type: oauth2 |
| 101 | + description: The oauth security descriptions |
| 102 | + flows: |
| 103 | + clientCredentials: |
| 104 | + tokenUrl: 'https://example.com/api/oauth/dialog' |
| 105 | + scopes: |
| 106 | + subscribe:auth_revocations: Scope required for authorization revocation topic |
0 commit comments