Package org.keycloak.admin.client.resource

Interface IdentityProvidersResource

public interface IdentityProvidersResource

Author:

pedroigor

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(IdentityProviderRepresentation identityProvider)
List<IdentityProviderRepresentation>	find(String search, Boolean briefRepresentation, Integer firstResult, Integer maxResults)
List<IdentityProviderRepresentation>	find(String search, Boolean briefRepresentation, Integer firstResult, Integer maxResults, Boolean realmOnly)	Get the paginated list of identity providers, filtered according to the specified parameters.
List<IdentityProviderRepresentation>	find(String type, String capability, String search, Boolean briefRepresentation, Integer firstResult, Integer maxResults)	Get the paginated list of identity providers, filtered according to the specified parameters.
List<IdentityProviderRepresentation>	findAll()
IdentityProviderResource	get(String alias)
jakarta.ws.rs.core.Response	getIdentityProviders(String providerId)
Map<String,String>	importFrom(Object data)
Map<String,String>	importFrom(Map<String,Object> data)

Method Details

get

@Path("instances/{alias}")
IdentityProviderResource get(@PathParam("alias")
 String alias)

findAll

@GET
@Path("instances")
@Produces("application/json")
List<IdentityProviderRepresentation> findAll()

find

@GET
@Path("instances")
@Produces("application/json")
List<IdentityProviderRepresentation> find(@QueryParam("type")
 String type,
 @QueryParam("capability")
 String capability,
 @QueryParam("search")
 String search,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

Get the paginated list of identity providers, filtered according to the specified parameters.

Parameters:

type - Type of identity provider. See the class org.keycloak.models.IdentityProviderType for the available values. When parameter is omitted, there is no filtering by type. This parameter is available since Keycloak 26.5.0

capability - Capability of identity provider. Used just if type is omitted. See the class org.keycloak.models.IdentityProviderCapability for the available values. When parameter is omitted, there is no filtering by capability. This parameter is available since Keycloak 26.5.0

search - Filter to search specific providers by name. Search can be prefixed (name*), contains (*name*) or exact (\"name\"). Default prefixed.

briefRepresentation - Boolean which defines whether brief representations are returned (default: false). If true, only basic data like ID, alias, providerId and enabled status will be returned in the result

firstResult - Pagination offset

maxResults - Maximum results size (defaults to 100)

Returns:

The list of providers.

find

@GET
@Path("instances")
@Produces("application/json")
List<IdentityProviderRepresentation> find(@QueryParam("search")
 String search,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults)

find

@GET
@Path("instances")
@Produces("application/json")
List<IdentityProviderRepresentation> find(@QueryParam("search")
 String search,
 @QueryParam("briefRepresentation")
 Boolean briefRepresentation,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResults,
 @QueryParam("realmOnly")
 Boolean realmOnly)

Get the paginated list of identity providers, filtered according to the specified parameters.

Parameters:

search - Filter to search specific providers by name. Search can be prefixed (name*), contains (*name*) or exact (\"name\"). Default prefixed.

briefRepresentation - Boolean which defines whether brief representations are returned (default: false). If true, only basic data like ID, alias, providerId and enabled status will be returned in the result

firstResult - Pagination offset

maxResults - Maximum results size (defaults to 100)

realmOnly - Boolean which defines if only realm-level IDPs (not associated with orgs) should be returned (default: false). Parameter available since Keycloak server 26. Will be ignored on older Keycloak versions with the default value false

Returns:

The list of providers.

create

@POST
@Path("instances")
@Consumes("application/json")
jakarta.ws.rs.core.Response create(IdentityProviderRepresentation identityProvider)

getIdentityProviders

@GET
@Path("/providers/{provider_id}")
@Produces("application/json")
jakarta.ws.rs.core.Response getIdentityProviders(@PathParam("provider_id")
 String providerId)

importFrom

@POST
@Path("import-config")
@Consumes("multipart/form-data")
@Produces("application/json")
Map<String,String> importFrom(Object data)

importFrom

@POST
@Path("import-config")
@Consumes("application/json")
@Produces("application/json")
Map<String,String> importFrom(Map<String,Object> data)