Skip to content
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.

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

Add REST API specification for SAML APIs #72839

Merged
merged 3 commits into from
Jun 24, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"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"
sethmlarson marked this conversation as resolved.
Show resolved Hide resolved
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"]
Copy link
Contributor

@albertzaharovits albertzaharovits May 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

     "content_type": ["application/json"]

I don't know if this is used (idem the rest).

},
"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,27 @@
{
"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"]
},
"url":{
"paths":[
{
"path":"/_security/saml/invalidate",
"methods":[
"POST"
]
}
]
},
"body":{
"description":"The LogoutRequest message",
sethmlarson marked this conversation as resolved.
Show resolved Hide resolved
"required":true
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"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"]
},
"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,27 @@
{
"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"]
},
"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",
sethmlarson marked this conversation as resolved.
Show resolved Hide resolved
"required":true
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"security.saml_sp_metadata":{
sethmlarson marked this conversation as resolved.
Show resolved Hide resolved
"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"
sethmlarson marked this conversation as resolved.
Show resolved Hide resolved
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"]
},
"url":{
"paths":[
{
"path":"/_security/saml/metadata/{realm_name}",
"methods":[
"GET"
],
"parts":{
"name":{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be realm_name instead of name.

"type":"string",
"description":"The name of the SAML realm to get the metadata for"
}
}
}
]
}
}
}