Package org.keycloak.admin.client.resource

Interface OrganizationMembersResource

public interface OrganizationMembersResource

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addMember(String userId)
Long	count()
List<MemberRepresentation>	getAll()	Deprecated.
List<OrganizationRepresentation>	getOrganizations(String id, boolean briefRepresentation)
jakarta.ws.rs.core.Response	inviteExistingUser(String id)
jakarta.ws.rs.core.Response	inviteUser(String email, String firstName, String lastName)
List<MemberRepresentation>	list(Integer firstResult, Integer maxResults)	Return members in the organization.
OrganizationMemberResource	member(String id)
jakarta.ws.rs.core.Response	removeMember(String memberId)
List<MemberRepresentation>	search(String search, Boolean exact, Integer first, Integer max)	Return all organization members that match the specified filters.
List<MemberRepresentation>	search(String search, Boolean exact, MembershipType membershipType, Integer first, Integer max)	Return all organization members that match the specified filters.

Method Details

addMember

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

removeMember

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

getAll

@Deprecated
@GET
@Produces("application/json")
List<MemberRepresentation> getAll()

Deprecated.

Return all members in the organization.

Returns:

a list containing the organization members.

list

@GET
@Produces("application/json")
List<MemberRepresentation> list(@QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

Return members in the organization.

Parameters:

first - index of the first element (pagination offset).

max - the maximum number of results.

Returns:

a list containing organization members.

search

@GET
@Produces("application/json")
List<MemberRepresentation> search(@QueryParam("search")
 String search,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Return all organization members that match the specified filters.

Parameters:

search - a String representing either a member's username, e-mail, first name, or last name.

exact - if true, the members will be searched using exact match for the search param - i.e. at least one of the username main attributes must match exactly the search param. If false, the method returns all members with at least one main attribute partially matching the search param.

first - index of the first element (pagination offset).

max - the maximum number of results.

Returns:

a list containing the matched organization members.

search

@GET
@Produces("application/json")
List<MemberRepresentation> search(@QueryParam("search")
 String search,
 @QueryParam("exact")
 Boolean exact,
 @QueryParam("membershipType")
 MembershipType membershipType,
 @QueryParam("first")
 Integer first,
 @QueryParam("max")
 Integer max)

Return all organization members that match the specified filters.

Parameters:

search - a String representing either a member's username, e-mail, first name, or last name.

exact - if true, the members will be searched using exact match for the search param - i.e. at least one of the username main attributes must match exactly the search param. If false, the method returns all members with at least one main attribute partially matching the search param.

membershipType - The MembershipType. The parameter is supported since Keycloak 26.1

first - index of the first element (pagination offset).

max - the maximum number of results.

Returns:

a list containing the matched organization members.

Since:

Keycloak 26.1. Use method search(String, Boolean, Integer, Integer) for the older versions of the Keycloak server

member

@Path("{id}")
OrganizationMemberResource member(@PathParam("id")
 String id)

inviteUser

@POST
@Path("invite-user")
@Consumes("application/x-www-form-urlencoded")
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")
jakarta.ws.rs.core.Response inviteExistingUser(@FormParam("id")
 String id)

count

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

Returns:

count of members of the organization

Since:

Keycloak server 26

getOrganizations

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