Package org.keycloak.services.resources.admin

Class IdentityProviderResource

java.lang.Object
org.keycloak.services.resources.admin.IdentityProviderResource
public class IdentityProviderResource extends Object
Author:
Pedro Igor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final org.jboss.logging.Logger
    logger
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    IdentityProviderResource(AdminPermissionEvaluator auth, RealmModel realm, KeycloakSession session, IdentityProviderModel identityProviderModel, AdminEventBuilder adminEvent)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    addMapper(org.keycloak.representations.idm.IdentityProviderMapperRepresentation mapper)
    Add a mapper to identity provider
    jakarta.ws.rs.core.Response
    delete()
    Delete the identity provider
    void
    delete(String id)
    Delete a mapper for the identity provider
    jakarta.ws.rs.core.Response
    export(String format)
    Export public broker configuration for identity provider
    org.keycloak.representations.idm.IdentityProviderRepresentation
    getIdentityProvider()
    Get the identity provider
    org.keycloak.representations.idm.ManagementPermissionReference
    getManagementPermissions()
    Return object stating whether client Authorization permissions have been initialized or not and a reference
    org.keycloak.representations.idm.IdentityProviderMapperRepresentation
    getMapperById(String id)
    Get mapper by id for the identity provider
    Stream<org.keycloak.representations.idm.IdentityProviderMapperRepresentation>
    getMappers()
    Get mappers for identity provider
    Map<String,org.keycloak.representations.idm.IdentityProviderMapperTypeRepresentation>
    getMapperTypes()
    Get mapper types for identity provider
    boolean
    reloadKeys()
     
    org.keycloak.representations.idm.ManagementPermissionReference
    setManagementPermissionsEnabled(org.keycloak.representations.idm.ManagementPermissionReference ref)
    Return object stating whether client Authorization permissions have been initialized or not and a reference
    void
    update(String id, org.keycloak.representations.idm.IdentityProviderMapperRepresentation rep)
    Update a mapper for the identity provider
    jakarta.ws.rs.core.Response
    update(org.keycloak.representations.idm.IdentityProviderRepresentation providerRep)
    Update the identity provider

    Methods inherited from class java.lang.Object

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

  • Field Details

    • logger

      protected static final org.jboss.logging.Logger logger

  • Constructor Details

  • Method Details

    • getIdentityProvider

      @GET @Produces("application/json") public org.keycloak.representations.idm.IdentityProviderRepresentation getIdentityProvider()
      Get the identity provider
      Returns:

    • delete

      @DELETE public jakarta.ws.rs.core.Response delete()
      Delete the identity provider
      Returns:

    • update

      @PUT @Consumes("application/json") public jakarta.ws.rs.core.Response update(org.keycloak.representations.idm.IdentityProviderRepresentation providerRep)
      Update the identity provider
      Parameters:
      providerRep -
      Returns:

    • export

      @GET @Path("export") public jakarta.ws.rs.core.Response export(@QueryParam("format") String format)
      Export public broker configuration for identity provider
      Parameters:
      format - Format to use
      Returns:

    • getMapperTypes

      @GET @Path("mapper-types") public Map<String,org.keycloak.representations.idm.IdentityProviderMapperTypeRepresentation> getMapperTypes()
      Get mapper types for identity provider

    • getMappers

      @GET @Path("mappers") @Produces("application/json") public Stream<org.keycloak.representations.idm.IdentityProviderMapperRepresentation> getMappers()
      Get mappers for identity provider

    • addMapper

      @POST @Path("mappers") @Consumes("application/json") public jakarta.ws.rs.core.Response addMapper(org.keycloak.representations.idm.IdentityProviderMapperRepresentation mapper)
      Add a mapper to identity provider
      Parameters:
      mapper -
      Returns:

    • getMapperById

      @GET @Path("mappers/{id}") @Produces("application/json") public org.keycloak.representations.idm.IdentityProviderMapperRepresentation getMapperById(@PathParam("id") String id)
      Get mapper by id for the identity provider
      Parameters:
      id -
      Returns:

    • update

      @PUT @Path("mappers/{id}") @Consumes("application/json") public void update(@PathParam("id") String id, org.keycloak.representations.idm.IdentityProviderMapperRepresentation rep)
      Update a mapper for the identity provider
      Parameters:
      id - Mapper id
      rep -

    • delete

      @DELETE @Path("mappers/{id}") public void delete(@PathParam("id") String id)
      Delete a mapper for the identity provider
      Parameters:
      id - Mapper id

    • getManagementPermissions

      @Path("management/permissions") @GET @Produces("application/json") public org.keycloak.representations.idm.ManagementPermissionReference getManagementPermissions()
      Return object stating whether client Authorization permissions have been initialized or not and a reference
      Returns:

    • setManagementPermissionsEnabled

      @Path("management/permissions") @PUT @Produces("application/json") @Consumes("application/json") public org.keycloak.representations.idm.ManagementPermissionReference setManagementPermissionsEnabled(org.keycloak.representations.idm.ManagementPermissionReference ref)
      Return object stating whether client Authorization permissions have been initialized or not and a reference
      Returns:
      initialized manage permissions reference

    • reloadKeys

      @GET @Path("reload-keys") @Produces("application/json") public boolean reloadKeys()