Package org.keycloak.organization.admin.resource

Class OrganizationMemberResource

java.lang.Object

org.keycloak.organization.admin.resource.OrganizationMemberResource

public class OrganizationMemberResource
extends Object

Constructor Summary

Constructors

Constructor	Description
OrganizationMemberResource(KeycloakSession session, OrganizationModel organization, AdminEventBuilder adminEvent, AdminPermissionEvaluator auth)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addMember(String id)
Long	count()	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization).
jakarta.ws.rs.core.Response	delete(String memberId)
MemberRepresentation	get(String memberId)	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization).
Stream<OrganizationRepresentation>	getOrganizations(String memberId, boolean briefRepresentation)	Precondition: when reached via the per-org path, the caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization).
Stream<GroupRepresentation>	groupMemberships(String memberId, Integer firstResult, Integer maxResults, String search, boolean briefRepresentation)	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization).
jakarta.ws.rs.core.Response	inviteExistingUser(String id)
jakarta.ws.rs.core.Response	inviteUser(String email, String firstName, String lastName)
Stream<MemberRepresentation>	search(String search, Boolean exact, Integer first, Integer max, String membershipType, boolean briefRepresentation)	Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization).

Methods inherited from class java.lang.Object

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

Constructor Details

OrganizationMemberResource

public OrganizationMemberResource(KeycloakSession session,
 OrganizationModel organization,
 AdminEventBuilder adminEvent,
 AdminPermissionEvaluator auth)

Method Details

addMember

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

inviteUser

@Path("invite-user")
@POST
@Consumes("application/x-www-form-urlencoded")
public jakarta.ws.rs.core.Response inviteUser(@FormParam("email")
 String email,
 @FormParam("firstName")
 String firstName,
 @FormParam("lastName")
 String lastName)

inviteExistingUser

@POST
@Path("invite-existing-user")
@Consumes("application/x-www-form-urlencoded")
public jakarta.ws.rs.core.Response inviteExistingUser(@FormParam("id")
 String id)

search

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

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization). This method additionally requires auth.users().requireQuery().

get

@Path("{member-id}")
@GET
@Produces("application/json")
public MemberRepresentation get(@PathParam("member-id")
 String memberId)

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization). This method additionally requires auth.users().requireView(member).

delete

@Path("{member-id}")
@DELETE
public jakarta.ws.rs.core.Response delete(@PathParam("member-id")
 String memberId)

getOrganizations

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

Precondition: when reached via the per-org path, the caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization). When reached via the collection-level path (/organizations/members/{id}/organizations), the caller passes through OrganizationsResource#getOrganizations(String) which enforces auth.orgs().requireQuery(). This method additionally requires auth.users().requireView(member) and filters returned organizations by auth.orgs().canView(org).

groupMemberships

@Path("{member-id}/groups")
@GET
@Produces("application/json")
public Stream<GroupRepresentation> groupMemberships(@PathParam("member-id")
 String memberId,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("search")
 String search,
 @QueryParam("briefRepresentation") @DefaultValue("true")
 boolean briefRepresentation)

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization). This method additionally requires auth.users().requireView(member).

count

@Path("count")
@GET
@Produces("application/json")
public Long count()

Precondition: caller must have passed through OrganizationsResource.get(String) which enforces auth.orgs().requireView(organization). This method additionally requires auth.users().requireQuery().