Package org.keycloak.admin.client.resource

Interface OrganizationIdentityProviderResource

public interface OrganizationIdentityProviderResource

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	delete()
List<GroupRepresentation>	getGroups(String search, String searchQuery, Boolean exact, Integer first, Integer max, boolean briefRepresentation, boolean subGroupsCount)	Returns organization groups for the identity provider with the specified alias.
IdentityProviderRepresentation	toRepresentation()

Method Details

toRepresentation

@GET
@Produces("application/json")
IdentityProviderRepresentation toRepresentation()

delete

@DELETE
jakarta.ws.rs.core.Response delete()

getGroups

@Path("groups")
@GET
@Produces("application/json")
List<GroupRepresentation> getGroups(@QueryParam("search")
 String search,
 @QueryParam("q")
 String searchQuery,
 @QueryParam("exact") @DefaultValue("false")
 Boolean exact,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation,
 @QueryParam("subGroupsCount") @DefaultValue("false")
 boolean subGroupsCount)

Returns organization groups for the identity provider with the specified alias. It allows filtering and displaying only the organization groups that are valid for the given identity provider. Only returns groups if the identity provider is associated with the organization and the organization is enabled. Otherwise, returns an error or empty stream.

Parameters:

search - a string to search for in group names

searchQuery - a query to search for group attributes, in the format 'key1:value1 key2:value2'

exact - if true, perform exact match on the search parameter

first - the position of the first result (pagination offset)

max - the maximum number of results to return

briefRepresentation - if true, return brief group representation; otherwise return full representation

Returns:

a stream of organization groups associated with the organization

Since:

Keycloak server 26.6.0