cloudfoundry / cloudfoundry/uaa

[Feature] Paging for retrieval of all identity providers for a given identity zone

Open
#3,145 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.6k
Forks
844
Avg merge
2d 5h
Merged PRs (30d)
27

Description

What version of UAA are you running?

77.18.0

How are you deploying the UAA?

I am deploying the UAA

  • using cf-deployment
What did you do?

Retrieval of all identity providers via endpoint /identity-providers for a given identity zone.

What did you expect to see? What goal are you trying to achieve with the UAA?

Besides the option to retrieve all identity providers, the caller of /identity-providers has the option to use paging to restrict the result set of the UAA response. The paging may be similar to the SCIM API (/Users, /Groups). With regards to the page size, the API may define a default (e.g. 100) and a maximum value (e.g. 500) if paging is requested.

The default behaviour of the API should stay as is, namely returning all identity providers for the given identity zone.

The goals for identity zones with a very high amount of identity providers are:

  • Allow the caller of the API to use paging to ensure appropriate response times
What did you see instead?

No paging mechanism supported for endpoint /identity-providers.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the /identity-providers endpoint and compare its documented behavior with the SCIM /Users and /Groups paging APIs. Define optional paging with documented default and maximum page sizes while preserving the current all-results behavior when paging is not requested; update the relevant API documentation and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, authentication
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.