Skip to content

Provide public keys via .well-known #27

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.

Sign up for GitHub

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

Open
samdze wants to merge 1 commit into
base: v2s
Choose a base branch
from
Open

Provide public keys via .well-known #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2341,6 +2341,71 @@
}
}
}
},
"/.well-known/jwks.json": {
"get": {
"summary": "List FlowPay JWKS",
"description": "Returns the JSON Web Key Set (JWKS) containing the public keys used by FlowPay to sign payloads. Use these keys to verify the signatures of incoming webhooks.",
"operationId": "getJWKs",
"tags": [
"Well Known"
],
"responses": {
"200": {
"description": "JWKS containing FlowPay public keys.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JWK"
},
"description": "Array of JSON Web Keys (JWKs)."
}
},
"required": [
"keys"
]
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultError"
}
}
}
},
"/.well-known/jwks/{kid}": {
"get": {
"summary": "Get a JWK by Key ID",
"description": "Returns the JSON Web Key (JWK) corresponding to the specified key ID (kid). Use this endpoint to retrieve a specific public key for verifying signatures.",
"operationId": "getJWK",
"tags": [
"Well Known"
],
"responses": {
"200": {
"description": "JWK corresponding to the specified key ID.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JWK"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"default": {
"$ref": "#/components/responses/DefaultError"
}
}
}
}
},
"webhooks": {
Expand Down Expand Up @@ -3492,6 +3557,42 @@
"currency",
"direction"
]
},
"JWK": {
"type": "object",
"properties": {
"kty": {
"type": "string",
"description": "Parameter identifying the cryptographic algorithm family used with the key."
},
"use": {
"type": "string",
"description": "Parameter identifying the intended use of the public key."
},
"kid": {
"type": "string",
"description": "Parameter used to match a specific key. The `kid` value is a case-sensitive string."
},
"alg": {
"type": "string",
"description": "Parameter identifying the specific algorithm used with the key."
},
"crv": {
"type": "string",
"description": "Parameter identifying the cryptographic curve used with the key."
},
"x": {
"type": "string",
"description": "Parameter representing the x coordinate for the elliptic curve point."
}
},
"required": [
"kty",
"kid",
"alg",
"crv",
"x"
]
}
}
}
Expand Down