spec release

This commit is contained in:
Adyen Automation
2024-12-11 10:10:39 +01:00
parent 8c0843d980
commit 0f5c7748f2
2 changed files with 60 additions and 58 deletions

View File

@@ -1,11 +1,11 @@
{
"openapi" : "3.1.0",
"servers" : [ {
"url" : "https://authe-live.adyen.com/authe/api/v1",
"description" : "Live Environment"
}, {
"url" : "https://test.adyen.com/authe/api/v1",
"description" : "Test Environment"
}, {
"url" : "https://authe-live.adyen.com/authe/api/v1",
"description" : "Live Environment"
} ],
"info" : {
"title" : "Session authentication API",
@@ -16,7 +16,7 @@
"url" : "https://github.com/Adyen/adyen-openapi"
},
"version" : "1",
"x-timestamp" : "2024-10-17T10:29:09Z"
"x-timestamp" : "2024-12-10T11:26:50Z"
},
"tags" : [ {
"name" : "Session authentication"
@@ -32,7 +32,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SessionRequest"
"$ref" : "#/components/schemas/AuthenticationSessionRequest"
},
"examples" : {
"create-session-platform" : {
@@ -76,7 +76,7 @@
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SessionResponse"
"$ref" : "#/components/schemas/AuthenticationSessionResponse"
},
"examples" : {
"create-session-platform" : {
@@ -174,6 +174,7 @@
}
}
},
"x-methodName" : "createAuthenticationSession",
"x-sortIndex" : 0
}
}
@@ -195,6 +196,24 @@
}
} ]
},
"AuthenticationSessionRequest" : {
"required" : [ "allowOrigin", "policy", "product" ],
"type" : "object",
"properties" : {
"allowOrigin" : {
"type" : "string",
"description" : "The URL where the component will appear. In your live environment, you must protect the URL with an SSL certificate and ensure that it starts with `https://`."
},
"policy" : {
"description" : "An object that contains a description of the allowed resources and roles for the requested session.",
"$ref" : "#/components/schemas/Policy"
},
"product" : {
"description" : "The type of component.\n\nFor [Onboarding components](https://docs.adyen.com/platforms/onboard-users/components), set this to **onboarding**.\n\nFor [Platform Experience components](https://docs.adyen.com/platforms/build-user-dashboards), set this to **platform**.",
"$ref" : "#/components/schemas/ProductType"
}
}
},
"BalanceAccountResource" : {
"required" : [ "balanceAccountId" ],
"type" : "object",
@@ -299,25 +318,7 @@
"type" : "string",
"enum" : [ "legalEntity", "balanceAccount", "accountHolder", "merchantAccount", "paymentInstrument" ]
},
"SessionRequest" : {
"required" : [ "allowOrigin", "policy", "product" ],
"type" : "object",
"properties" : {
"allowOrigin" : {
"type" : "string",
"description" : "The URL where the component will appear. In your live environment, you must protect the URL with an SSL certificate and ensure that it starts with `https://`."
},
"policy" : {
"description" : "An object that contains a description of the allowed resources and roles for the requested session.",
"$ref" : "#/components/schemas/Policy"
},
"product" : {
"description" : "The type of component.\n\nFor [Onboarding components](https://docs.adyen.com/platforms/onboard-users/components), set this to **onboarding**.\n\nFor [Platform Experience components](https://docs.adyen.com/platforms/build-user-dashboards), set this to **platform**.",
"$ref" : "#/components/schemas/ProductType"
}
}
},
"SessionResponse" : {
"AuthenticationSessionResponse" : {
"type" : "object",
"properties" : {
"id" : {