Skip to content

Commit

Permalink
Add REST API specification for SAML APIs (elastic#72839)
Browse files Browse the repository at this point in the history
These API specifications were originally not added as we considered 
them internal.
  • Loading branch information
jkakavas committed Jun 24, 2021
1 parent 30ecf8b commit 5903054
Show file tree
Hide file tree
Showing 5 changed files with 142 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"security.saml_authenticate":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html",
"description":"Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair"
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_security/saml/authenticate",
"methods":[
"POST"
]
}
]
},
"body":{
"description":"The SAML response to authenticate",
"required":true
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"security.saml_invalidate":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html",
"description":"Consumes a SAML LogoutRequest"
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_security/saml/invalidate",
"methods":[
"POST"
]
}
]
},
"body":{
"description":"The LogoutRequest message",
"required":true
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"security.saml_logout":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html",
"description":"Invalidates an access token and a refresh token that were generated via the SAML Authenticate API"
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_security/saml/logout",
"methods":[
"POST"
]
}
]
},
"body":{
"description":"The tokens to invalidate",
"required":true
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"security.saml_prepare_authentication":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html",
"description":"Creates a SAML authentication request"
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_security/saml/prepare",
"methods":[
"POST"
]
}
]
},
"body":{
"description":"The realm for which to create the authentication request, identified by either its name or the ACS URL",
"required":true
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"security.saml_service_provider_metadata":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html",
"description":"Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider"
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"],
"content_type": ["application/json"]
},
"url":{
"paths":[
{
"path":"/_security/saml/metadata/{realm_name}",
"methods":[
"GET"
],
"parts":{
"realm_name":{
"type":"string",
"description":"The name of the SAML realm to get the metadata for"
}
}
}
]
}
}
}

0 comments on commit 5903054

Please sign in to comment.