ForgeRockStorage

class gafaelfawr.storage.forgerock.ForgeRockStorage(*, config, http_client, logger)

Bases: object

Perform ForgeRock Identity Management lookups.

Parameters:

• config (ForgeRockConfig) – ForgeRock Identity Management configuration.

• http_client (AsyncClient) – HTTP client to use.

• logger (BoundLogger) – Logger to use.

Methods Summary

get_gid(group_name)

Get the GID of a group from ForgeRock Identity Management.

Methods Documentation

async get_gid(group_name)

Get the GID of a group from ForgeRock Identity Management.

Parameters:

group_name (str) – Name of the group.

Returns:

GID if found, else None.

Return type:

int or None

Raises:

ForgeRockError – Raised if some error occured querying the ForgeRock server (other than that the group was not found).

Notes

This issues a name eq group_name query against the system/freeipa/group endpoint, which appears to be the correct place to find group information for at least one installation of the ForgeRock Identity Management server. This may or may not generalize to other installations.