Skip to content

Commit

Permalink
chore: fix SAML app openapi json files
Browse files Browse the repository at this point in the history
  • Loading branch information
darcyYe committed Jan 27, 2025
1 parent f7d8dfa commit ab54670
Show file tree
Hide file tree
Showing 4 changed files with 215 additions and 198 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,202 +9,6 @@
}
],
"paths": {
"/api/saml-applications/{id}/metadata": {
"get": {
"summary": "Get SAML application metadata",
"description": "Get the SAML metadata XML for the application.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the SAML application."
}
],
"responses": {
"200": {
"description": "The SAML metadata XML.",
"content": {
"text/xml": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Invalid request."
},
"404": {
"description": "The SAML application was not found."
}
}
}
},
"/api/saml-applications/{id}/callback": {
"get": {
"summary": "SAML application callback",
"description": "Handle the OIDC callback for SAML application and generate SAML response.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the SAML application."
},
{
"name": "code",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The authorization code from OIDC callback."
},
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
},
"description": "The state parameter from OIDC callback."
},
{
"name": "redirectUri",
"in": "query",
"schema": {
"type": "string"
},
"description": "The redirect URI for the callback."
}
],
"responses": {
"200": {
"description": "Returns an HTML form that automatically submits the SAML response."
},
"400": {
"description": "Invalid request or OIDC error."
},
"404": {
"description": "The SAML application was not found."
}
}
}
},
"/api/saml/{id}/authn": {
"get": {
"summary": "Handle SAML authentication request (Redirect binding)",
"description": "Process SAML authentication request using HTTP Redirect binding.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the SAML application."
},
{
"name": "SAMLRequest",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The SAML request message."
},
{
"name": "Signature",
"in": "query",
"schema": {
"type": "string"
},
"description": "The signature of the request."
},
{
"name": "SigAlg",
"in": "query",
"schema": {
"type": "string"
},
"description": "The signature algorithm."
},
{
"name": "RelayState",
"in": "query",
"schema": {
"type": "string"
},
"description": "The relay state parameter."
}
],
"responses": {
"302": {
"description": "Redirects to the sign-in page."
},
"400": {
"description": "Invalid SAML request."
},
"404": {
"description": "The SAML application was not found."
}
}
},
"post": {
"summary": "Handle SAML authentication request (POST binding)",
"description": "Process SAML authentication request using HTTP POST binding.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the SAML application."
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"SAMLRequest": {
"type": "string",
"description": "The SAML request message."
},
"RelayState": {
"type": "string",
"description": "The relay state parameter."
}
},
"required": ["SAMLRequest"]
}
}
}
},
"responses": {
"302": {
"description": "Redirects to the sign-in page."
},
"400": {
"description": "Invalid SAML request."
},
"404": {
"description": "The SAML application was not found."
}
}
}
},
"/api/saml-applications": {
"post": {
"summary": "Create SAML application",
Expand Down
Loading

0 comments on commit ab54670

Please sign in to comment.