Skip to content

Commit d7c5d80

Browse files
authored
Deprecate /_xpack/security/* in favor of /_security/* (#36293)
* This commit is part of our plan to deprecate and ultimately remove the use of _xpack in the REST APIs. - REST API docs - HLRC docs and doc tests - Handle REST actions with deprecation warnings - Changed endpoints in rest-api-spec and relevant file names
1 parent bf42ced commit d7c5d80

File tree

158 files changed

+968
-692
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+968
-692
lines changed

client/rest-high-level/src/main/java/org/elasticsearch/client/SecurityRequestConverters.java

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ private SecurityRequestConverters() {}
5656

5757
static Request changePassword(ChangePasswordRequest changePasswordRequest) throws IOException {
5858
String endpoint = new RequestConverters.EndpointBuilder()
59-
.addPathPartAsIs("_xpack/security/user")
59+
.addPathPartAsIs("_security/user")
6060
.addPathPart(changePasswordRequest.getUsername())
6161
.addPathPartAsIs("_password")
6262
.build();
@@ -69,7 +69,7 @@ static Request changePassword(ChangePasswordRequest changePasswordRequest) throw
6969

7070
static Request putUser(PutUserRequest putUserRequest) throws IOException {
7171
String endpoint = new RequestConverters.EndpointBuilder()
72-
.addPathPartAsIs("_xpack/security/user")
72+
.addPathPartAsIs("_security/user")
7373
.addPathPart(putUserRequest.getUser().getUsername())
7474
.build();
7575
Request request = new Request(HttpPut.METHOD_NAME, endpoint);
@@ -81,7 +81,7 @@ static Request putUser(PutUserRequest putUserRequest) throws IOException {
8181

8282
static Request deleteUser(DeleteUserRequest deleteUserRequest) {
8383
String endpoint = new RequestConverters.EndpointBuilder()
84-
.addPathPartAsIs("_xpack","security", "user")
84+
.addPathPartAsIs("_security", "user")
8585
.addPathPart(deleteUserRequest.getName())
8686
.build();
8787
Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
@@ -92,7 +92,7 @@ static Request deleteUser(DeleteUserRequest deleteUserRequest) {
9292

9393
static Request putRoleMapping(final PutRoleMappingRequest putRoleMappingRequest) throws IOException {
9494
final String endpoint = new RequestConverters.EndpointBuilder()
95-
.addPathPartAsIs("_xpack/security/role_mapping")
95+
.addPathPartAsIs("_security/role_mapping")
9696
.addPathPart(putRoleMappingRequest.getName())
9797
.build();
9898
final Request request = new Request(HttpPut.METHOD_NAME, endpoint);
@@ -104,7 +104,7 @@ static Request putRoleMapping(final PutRoleMappingRequest putRoleMappingRequest)
104104

105105
static Request getRoleMappings(final GetRoleMappingsRequest getRoleMappingRequest) throws IOException {
106106
RequestConverters.EndpointBuilder builder = new RequestConverters.EndpointBuilder();
107-
builder.addPathPartAsIs("_xpack/security/role_mapping");
107+
builder.addPathPartAsIs("_security/role_mapping");
108108
if (getRoleMappingRequest.getRoleMappingNames().size() > 0) {
109109
builder.addPathPart(Strings.collectionToCommaDelimitedString(getRoleMappingRequest.getRoleMappingNames()));
110110
}
@@ -121,7 +121,7 @@ static Request disableUser(DisableUserRequest disableUserRequest) {
121121

122122
private static Request setUserEnabled(SetUserEnabledRequest setUserEnabledRequest) {
123123
String endpoint = new RequestConverters.EndpointBuilder()
124-
.addPathPartAsIs("_xpack/security/user")
124+
.addPathPartAsIs("_security/user")
125125
.addPathPart(setUserEnabledRequest.getUsername())
126126
.addPathPart(setUserEnabledRequest.isEnabled() ? "_enable" : "_disable")
127127
.build();
@@ -132,14 +132,14 @@ private static Request setUserEnabled(SetUserEnabledRequest setUserEnabledReques
132132
}
133133

134134
static Request hasPrivileges(HasPrivilegesRequest hasPrivilegesRequest) throws IOException {
135-
Request request = new Request(HttpGet.METHOD_NAME, "/_xpack/security/user/_has_privileges");
135+
Request request = new Request(HttpGet.METHOD_NAME, "/_security/user/_has_privileges");
136136
request.setEntity(createEntity(hasPrivilegesRequest, REQUEST_BODY_CONTENT_TYPE));
137137
return request;
138138
}
139139

140140
static Request clearRealmCache(ClearRealmCacheRequest clearRealmCacheRequest) {
141141
RequestConverters.EndpointBuilder builder = new RequestConverters.EndpointBuilder()
142-
.addPathPartAsIs("_xpack/security/realm");
142+
.addPathPartAsIs("_security/realm");
143143
if (clearRealmCacheRequest.getRealms().isEmpty() == false) {
144144
builder.addCommaSeparatedPathParts(clearRealmCacheRequest.getRealms().toArray(Strings.EMPTY_ARRAY));
145145
} else {
@@ -156,7 +156,7 @@ static Request clearRealmCache(ClearRealmCacheRequest clearRealmCacheRequest) {
156156

157157
static Request clearRolesCache(ClearRolesCacheRequest disableCacheRequest) {
158158
String endpoint = new RequestConverters.EndpointBuilder()
159-
.addPathPartAsIs("_xpack/security/role")
159+
.addPathPartAsIs("_security/role")
160160
.addCommaSeparatedPathParts(disableCacheRequest.names())
161161
.addPathPart("_clear_cache")
162162
.build();
@@ -165,7 +165,7 @@ static Request clearRolesCache(ClearRolesCacheRequest disableCacheRequest) {
165165

166166
static Request deleteRoleMapping(DeleteRoleMappingRequest deleteRoleMappingRequest) {
167167
final String endpoint = new RequestConverters.EndpointBuilder()
168-
.addPathPartAsIs("_xpack/security/role_mapping")
168+
.addPathPartAsIs("_security/role_mapping")
169169
.addPathPart(deleteRoleMappingRequest.getName())
170170
.build();
171171
final Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
@@ -176,7 +176,7 @@ static Request deleteRoleMapping(DeleteRoleMappingRequest deleteRoleMappingReque
176176

177177
static Request deleteRole(DeleteRoleRequest deleteRoleRequest) {
178178
String endpoint = new RequestConverters.EndpointBuilder()
179-
.addPathPartAsIs("_xpack/security/role")
179+
.addPathPartAsIs("_security/role")
180180
.addPathPart(deleteRoleRequest.getName())
181181
.build();
182182
Request request = new Request(HttpDelete.METHOD_NAME, endpoint);
@@ -187,36 +187,36 @@ static Request deleteRole(DeleteRoleRequest deleteRoleRequest) {
187187

188188
static Request getRoles(GetRolesRequest getRolesRequest) {
189189
RequestConverters.EndpointBuilder builder = new RequestConverters.EndpointBuilder();
190-
builder.addPathPartAsIs("_xpack/security/role");
190+
builder.addPathPartAsIs("_security/role");
191191
if (getRolesRequest.getRoleNames().size() > 0) {
192192
builder.addPathPart(Strings.collectionToCommaDelimitedString(getRolesRequest.getRoleNames()));
193193
}
194194
return new Request(HttpGet.METHOD_NAME, builder.build());
195195
}
196196

197197
static Request createToken(CreateTokenRequest createTokenRequest) throws IOException {
198-
Request request = new Request(HttpPost.METHOD_NAME, "/_xpack/security/oauth2/token");
198+
Request request = new Request(HttpPost.METHOD_NAME, "/_security/oauth2/token");
199199
request.setEntity(createEntity(createTokenRequest, REQUEST_BODY_CONTENT_TYPE));
200200
return request;
201201
}
202202

203203
static Request invalidateToken(InvalidateTokenRequest invalidateTokenRequest) throws IOException {
204-
Request request = new Request(HttpDelete.METHOD_NAME, "/_xpack/security/oauth2/token");
204+
Request request = new Request(HttpDelete.METHOD_NAME, "/_security/oauth2/token");
205205
request.setEntity(createEntity(invalidateTokenRequest, REQUEST_BODY_CONTENT_TYPE));
206206
return request;
207207
}
208208

209209
static Request getPrivileges(GetPrivilegesRequest getPrivilegesRequest) {
210210
String endpoint = new RequestConverters.EndpointBuilder()
211-
.addPathPartAsIs("_xpack/security/privilege")
211+
.addPathPartAsIs("_security/privilege")
212212
.addPathPart(getPrivilegesRequest.getApplicationName())
213213
.addCommaSeparatedPathParts(getPrivilegesRequest.getPrivilegeNames())
214214
.build();
215215
return new Request(HttpGet.METHOD_NAME, endpoint);
216216
}
217217

218218
static Request putPrivileges(final PutPrivilegesRequest putPrivilegesRequest) throws IOException {
219-
Request request = new Request(HttpPut.METHOD_NAME, "/_xpack/security/privilege");
219+
Request request = new Request(HttpPut.METHOD_NAME, "/_security/privilege");
220220
request.setEntity(createEntity(putPrivilegesRequest, REQUEST_BODY_CONTENT_TYPE));
221221
RequestConverters.Params params = new RequestConverters.Params(request);
222222
params.withRefreshPolicy(putPrivilegesRequest.getRefreshPolicy());
@@ -225,7 +225,7 @@ static Request putPrivileges(final PutPrivilegesRequest putPrivilegesRequest) th
225225

226226
static Request deletePrivileges(DeletePrivilegesRequest deletePrivilegeRequest) {
227227
String endpoint = new RequestConverters.EndpointBuilder()
228-
.addPathPartAsIs("_xpack/security/privilege")
228+
.addPathPartAsIs("_security/privilege")
229229
.addPathPart(deletePrivilegeRequest.getApplication())
230230
.addCommaSeparatedPathParts(deletePrivilegeRequest.getPrivileges())
231231
.build();
@@ -237,7 +237,7 @@ static Request deletePrivileges(DeletePrivilegesRequest deletePrivilegeRequest)
237237

238238
static Request putRole(final PutRoleRequest putRoleRequest) throws IOException {
239239
final String endpoint = new RequestConverters.EndpointBuilder()
240-
.addPathPartAsIs("_xpack/security/role")
240+
.addPathPartAsIs("_security/role")
241241
.addPathPart(putRoleRequest.getRole().getName())
242242
.build();
243243
final Request request = new Request(HttpPut.METHOD_NAME, endpoint);

client/rest-high-level/src/main/java/org/elasticsearch/client/security/AuthenticateRequest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ private AuthenticateRequest() {
3535
}
3636

3737
public Request getRequest() {
38-
return new Request(HttpGet.METHOD_NAME, "/_xpack/security/_authenticate");
38+
return new Request(HttpGet.METHOD_NAME, "/_security/_authenticate");
3939
}
4040

4141
}

client/rest-high-level/src/main/java/org/elasticsearch/client/security/GetSslCertificatesRequest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@
2626
/**
2727
* Request object to retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster.
2828
*/
29-
public final class GetSslCertificatesRequest implements Validatable{
29+
public final class GetSslCertificatesRequest implements Validatable {
3030

3131
public static final GetSslCertificatesRequest INSTANCE = new GetSslCertificatesRequest();
3232

33-
private GetSslCertificatesRequest(){
33+
private GetSslCertificatesRequest() {
3434
}
3535

3636
public Request getRequest() {
37-
return new Request(HttpGet.METHOD_NAME, "/_xpack/ssl/certificates");
37+
return new Request(HttpGet.METHOD_NAME, "/_ssl/certificates");
3838
}
3939

4040
}

client/rest-high-level/src/test/java/org/elasticsearch/client/SecurityIT.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public void testPutUser() throws Exception {
7070
assertThat(updateUserResponse.isCreated(), is(false));
7171
// delete user
7272
final Request deleteUserRequest = new Request(HttpDelete.METHOD_NAME,
73-
"/_xpack/security/user/" + putUserRequest.getUser().getUsername());
73+
"/_security/user/" + putUserRequest.getUser().getUsername());
7474
highLevelClient().getLowLevelClient().performRequest(deleteUserRequest);
7575
}
7676

0 commit comments

Comments
 (0)