Skip to content

Commit 6887604

Browse files
authored
Add REST API specification for SAML APIs (#72839)
These API specifications were originally not added as we considered them internal.
1 parent 28b4982 commit 6887604

5 files changed

+142
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"security.saml_authenticate":{
3+
"documentation":{
4+
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html",
5+
"description":"Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair"
6+
},
7+
"stability":"stable",
8+
"visibility":"public",
9+
"headers":{
10+
"accept": [ "application/json"],
11+
"content_type": ["application/json"]
12+
},
13+
"url":{
14+
"paths":[
15+
{
16+
"path":"/_security/saml/authenticate",
17+
"methods":[
18+
"POST"
19+
]
20+
}
21+
]
22+
},
23+
"body":{
24+
"description":"The SAML response to authenticate",
25+
"required":true
26+
}
27+
}
28+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"security.saml_invalidate":{
3+
"documentation":{
4+
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html",
5+
"description":"Consumes a SAML LogoutRequest"
6+
},
7+
"stability":"stable",
8+
"visibility":"public",
9+
"headers":{
10+
"accept": [ "application/json"],
11+
"content_type": ["application/json"]
12+
},
13+
"url":{
14+
"paths":[
15+
{
16+
"path":"/_security/saml/invalidate",
17+
"methods":[
18+
"POST"
19+
]
20+
}
21+
]
22+
},
23+
"body":{
24+
"description":"The LogoutRequest message",
25+
"required":true
26+
}
27+
}
28+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"security.saml_logout":{
3+
"documentation":{
4+
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html",
5+
"description":"Invalidates an access token and a refresh token that were generated via the SAML Authenticate API"
6+
},
7+
"stability":"stable",
8+
"visibility":"public",
9+
"headers":{
10+
"accept": [ "application/json"],
11+
"content_type": ["application/json"]
12+
},
13+
"url":{
14+
"paths":[
15+
{
16+
"path":"/_security/saml/logout",
17+
"methods":[
18+
"POST"
19+
]
20+
}
21+
]
22+
},
23+
"body":{
24+
"description":"The tokens to invalidate",
25+
"required":true
26+
}
27+
}
28+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"security.saml_prepare_authentication":{
3+
"documentation":{
4+
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html",
5+
"description":"Creates a SAML authentication request"
6+
},
7+
"stability":"stable",
8+
"visibility":"public",
9+
"headers":{
10+
"accept": [ "application/json"],
11+
"content_type": ["application/json"]
12+
},
13+
"url":{
14+
"paths":[
15+
{
16+
"path":"/_security/saml/prepare",
17+
"methods":[
18+
"POST"
19+
]
20+
}
21+
]
22+
},
23+
"body":{
24+
"description":"The realm for which to create the authentication request, identified by either its name or the ACS URL",
25+
"required":true
26+
}
27+
}
28+
}
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"security.saml_service_provider_metadata":{
3+
"documentation":{
4+
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html",
5+
"description":"Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider"
6+
},
7+
"stability":"stable",
8+
"visibility":"public",
9+
"headers":{
10+
"accept": [ "application/json"],
11+
"content_type": ["application/json"]
12+
},
13+
"url":{
14+
"paths":[
15+
{
16+
"path":"/_security/saml/metadata/{realm_name}",
17+
"methods":[
18+
"GET"
19+
],
20+
"parts":{
21+
"realm_name":{
22+
"type":"string",
23+
"description":"The name of the SAML realm to get the metadata for"
24+
}
25+
}
26+
}
27+
]
28+
}
29+
}
30+
}

0 commit comments

Comments
 (0)