Package org.keycloak.services.resources.admin

Class IdentityProviderResource

  • public class IdentityProviderResource
extends Object
    Author:
    Pedro Igor

    • Field Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response addMapper​(org.keycloak.representations.idm.IdentityProviderMapperRepresentation mapper)
      Add a mapper to identity provider
      javax.ws.rs.core.Response delete()
      Delete the identity provider
      void delete​(String id)
      Delete a mapper for the identity provider
      javax.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
      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
      static org.keycloak.representations.idm.ManagementPermissionReference toMgmtRef​(org.keycloak.models.IdentityProviderModel model, AdminPermissionManagement permissions)  
      void update​(String id, org.keycloak.representations.idm.IdentityProviderMapperRepresentation rep)
      Update a mapper for the identity provider
      javax.ws.rs.core.Response update​(org.keycloak.representations.idm.IdentityProviderRepresentation providerRep)
      Update the identity provider

    • Field Detail

      • logger

        protected static final org.jboss.logging.Logger logger

    • Constructor Detail

      • IdentityProviderResource

        public IdentityProviderResource​(AdminPermissionEvaluator auth,
                                org.keycloak.models.RealmModel realm,
                                org.keycloak.models.KeycloakSession session,
                                org.keycloak.models.IdentityProviderModel identityProviderModel,
                                AdminEventBuilder adminEvent)

    • Method Detail

      • getIdentityProvider

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

      • delete

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

      • update

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

      • export

        @GET
@Path("export")
public javax.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 javax.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:

      • toMgmtRef

        public static org.keycloak.representations.idm.ManagementPermissionReference toMgmtRef​(org.keycloak.models.IdentityProviderModel model,
                                                                                       AdminPermissionManagement permissions)

      • 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