Change parameter for list of identity providers to 'active_only'

Signed-off-by: Madhura Bhave <mbhave@pivotal.io>
cloudfoundry · Apr 22, 2015 · c9c2772 · c9c2772
1 parent 36d7ff1
commit c9c2772
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/UAA-APIs.rst b/docs/UAA-APIs.rst
@@ -896,7 +896,7 @@ Identity Provider API Documentation
 Request             ``GET /identity-providers/{id}`` (returns a single provider) or ``GET /identity-providers`` (returns an array of providers)
 Header              ``X-Identity-Zone-Id`` (if using zones.<id>.admin scope against default UAA zone)
 Scopes Required     ``zones.<zone id>.admin`` or ``idps.read``
-Request Parameters  retrieveActive (optional parameter for /identity-providers). Set to true to retrieve only active Identity Providers
+Request Parameters  active_only (optional parameter for /identity-providers). Set to true to retrieve only active Identity Providers
 Response body       *example* ::
 
                      HTTP/1.1 200 OK

diff --git a/uaa/src/main/java/org/cloudfoundry/identity/uaa/zone/IdentityProviderEndpoints.java b/uaa/src/main/java/org/cloudfoundry/identity/uaa/zone/IdentityProviderEndpoints.java
@@ -83,9 +83,9 @@ public ResponseEntity<IdentityProvider> updateIdentityProvider(@PathVariable Str
     }
 
     @RequestMapping(method = GET)
-    public ResponseEntity<List<IdentityProvider>> retrieveIdentityProviders(@RequestParam(required = false) String retrieveActive) {
-        Boolean retrieveActiveIdps = Boolean.valueOf(retrieveActive);
-        List<IdentityProvider> identityProviderList = identityProviderProvisioning.retrieveAll(retrieveActiveIdps, IdentityZoneHolder.get().getId());
+    public ResponseEntity<List<IdentityProvider>> retrieveIdentityProviders(@RequestParam(value = "active_only", required = false) String activeOnly) {
+        Boolean retrieveActiveOnly = Boolean.valueOf(activeOnly);
+        List<IdentityProvider> identityProviderList = identityProviderProvisioning.retrieveAll(retrieveActiveOnly, IdentityZoneHolder.get().getId());
         return new ResponseEntity<>(identityProviderList, OK);
     }
 

diff --git a/.../java/org/cloudfoundry/identity/uaa/mock/zones/IdentityProviderEndpointsMockMvcTests.java b/.../java/org/cloudfoundry/identity/uaa/mock/zones/IdentityProviderEndpointsMockMvcTests.java
@@ -173,7 +173,7 @@ private void testRetrieveIdps(boolean retrieveActive) throws Exception {
         IdentityProvider identityProvider = MultitenancyFixture.identityProvider(randomOriginKey, IdentityZone.getUaa().getId());
         IdentityProvider createdIDP = createIdentityProvider(null, identityProvider, accessToken, status().isCreated());
 
-        String retrieveActiveParam = retrieveActive ? "?retrieveActive=true" : "";
+        String retrieveActiveParam = retrieveActive ? "?active_only=true" : "";
         MockHttpServletRequestBuilder requestBuilder = get("/identity-providers" + retrieveActiveParam)
                 .header("Authorization", "Bearer" + accessToken)
                 .contentType(APPLICATION_JSON);