📌 Design Question: Pass Entity IDs or Objects as Parameters?

[mainick]

Hi everyone!

I'm currently working on a project enhancement that introduces support for the Keycloak Admin API too, you view feature/keycloak-admin-cli branch.
Some methods require specific entity identifiers in order to retrieve or manipulate related resources (e.g., client roles associated with a group).

🔍 Example (simplified and redacted)

public function clientRoles(string $realm, string $clientUuid, string $groupId): ?RoleCollection
{
    // Performs an admin API call to retrieve group roles for the given client
}

In the project, I’ve already implemented dedicated representation objects for each Keycloak entity, such as ClientRepresentation, GroupRepresentation, etc.

---

❓ The Question

In a project with strict_types=1, would you prefer that these methods accept:

• 🔢 Only the entity IDs (as they currently do), or
• 🧱 Entity representation objects (e.g., ClientRepresentation, GroupRepresentation), from which the IDs are extracted internally?

---

🗳️ Cast your vote in the poll below

Feel free to comment with your reasoning, preferences, or relevant use cases.

Thanks for contributing and helping shape the future of this project! 🙌