Package org.keycloak.organization.admin.resource

Class OrganizationIdentityProvidersResource

java.lang.Object

org.keycloak.organization.admin.resource.OrganizationIdentityProvidersResource

public class OrganizationIdentityProvidersResource
extends Object

Constructor Summary

Constructors

Constructor	Description
OrganizationIdentityProvidersResource(KeycloakSession session, OrganizationModel organization, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addIdentityProvider(String id)
jakarta.ws.rs.core.Response	delete(String alias)
Stream<GroupRepresentation>	getGroups(String alias, 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	getIdentityProvider(String alias)
Stream<IdentityProviderRepresentation>	getIdentityProviders()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrganizationIdentityProvidersResource

public OrganizationIdentityProvidersResource(KeycloakSession session,
 OrganizationModel organization,
 AdminEventBuilder adminEvent)

Method Details

addIdentityProvider

@POST
@Consumes("application/json")
public jakarta.ws.rs.core.Response addIdentityProvider(String id)

getIdentityProviders

@GET
@Produces("application/json")
public Stream<IdentityProviderRepresentation> getIdentityProviders()

getIdentityProvider

@Path("{alias}")
@GET
@Produces("application/json")
public IdentityProviderRepresentation getIdentityProvider(@PathParam("alias")
 String alias)

getGroups

@Path("{alias}/groups")
@GET
@Produces("application/json")
public Stream<GroupRepresentation> getGroups(@PathParam("alias")
 String alias,
 @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:

alias - the identity provider alias

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

delete

@Path("{alias}")
@DELETE
@Produces("application/json")
public jakarta.ws.rs.core.Response delete(@PathParam("alias")
 String alias)