Package org.keycloak.organization.admin.resource

Class OrganizationsResource

java.lang.Object

org.keycloak.organization.admin.resource.OrganizationsResource

public class OrganizationsResource
extends Object

Constructor Summary

Constructors

Constructor	Description
OrganizationsResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(OrganizationRepresentation organization)	Creates a new organization based on the specified OrganizationRepresentation.
OrganizationResource	get(String orgId)	Base path for the admin REST API for one particular organization.
long	getOrganizationCount(String search, String searchQuery, Boolean exact)	Returns the organizations counts.
Stream<OrganizationRepresentation>	getOrganizations(String memberId, boolean briefRepresentation)
Stream<OrganizationRepresentation>	search(String search, String searchQuery, Boolean exact, Integer first, Integer max, boolean briefRepresentation)	Returns a stream of organizations, filtered according to query parameters.

Methods inherited from class java.lang.Object

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

Constructor Details

OrganizationsResource

public OrganizationsResource(KeycloakSession session,
 AdminPermissionEvaluator auth,
 AdminEventBuilder adminEvent)

Method Details

create

@POST
@Consumes("application/json")
public jakarta.ws.rs.core.Response create(OrganizationRepresentation organization)

Creates a new organization based on the specified OrganizationRepresentation.

Parameters:

organization - the representation containing the organization data.

Returns:

a Response containing the status of the operation.

search

@GET
@Produces("application/json")
public Stream<OrganizationRepresentation> search(@QueryParam("search")
 String search,
 @QueryParam("q")
 String searchQuery,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first") @DefaultValue("0")
 Integer first,
 @QueryParam("max") @DefaultValue("10")
 Integer max,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Returns a stream of organizations, filtered according to query parameters.

Parameters:

search - a String representing either an organization name or domain.

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

exact - if true, the organizations will be searched using exact match for the search param - i.e. either the organization name or one of its domains must match exactly the search param. If false, the method returns all organizations whose name or (domains) partially match the search param.

first - the position of the first result to be processed (pagination offset). Ignored if negative or null.

max - the maximum number of results to be returned. Ignored if negative or null.

Returns:

a non-null Stream of matched organizations.

get

@Path("{org-id}")
public OrganizationResource get(@PathParam("org-id")
 String orgId)

Base path for the admin REST API for one particular organization.

getOrganizationCount

@GET
@Path("count")
@Produces("application/json")
public long getOrganizationCount(@QueryParam("search")
 String search,
 @QueryParam("q")
 String searchQuery,
 @QueryParam("exact")
 Boolean exact)

Returns the organizations counts.

Returns:

getOrganizations

@Path("members/{member-id}/organizations")
@GET
@Produces("application/json")
public Stream<OrganizationRepresentation> getOrganizations(@PathParam("member-id")
 String memberId,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)