org.keycloak.services.resources.admin.IdentityProvidersResource クラス

org.keycloak.services.resources.admin.IdentityProvidersResource 連携図

公開メンバ関数
	IdentityProvidersResource (RealmModel realm, KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
Response	getIdentityProviders (@PathParam("provider_id") String providerId)
Map< String, String >	importFrom (MultipartFormDataInput input) throws IOException
Map< String, String >	importFrom (Map< String, Object > data) throws IOException
List< IdentityProviderRepresentation >	getIdentityProviders ()
Response	create (IdentityProviderRepresentation representation)
IdentityProviderResource	getIdentityProvider (@PathParam("alias") String alias)

非公開メンバ関数
IdentityProviderFactory	getProviderFactorytById (String providerId)
List< ProviderFactory >	getProviderFactories ()

非公開変数類
final RealmModel	realm
final KeycloakSession	session
AdminPermissionEvaluator	auth
AdminEventBuilder	adminEvent

詳解

Identity Providers

著者

Pedro Igor

構築子と解体子

IdentityProvidersResource()

org.keycloak.services.resources.admin.IdentityProvidersResource.IdentityProvidersResource ( RealmModel  realm, KeycloakSession  session, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

                                                                                                                                             {
        this.realm = realm;
        this.session = session;
        this.auth = auth;
        this.adminEvent = adminEvent.resource(ResourceType.IDENTITY_PROVIDER);
    }

関数詳解

create()

Response org.keycloak.services.resources.admin.IdentityProvidersResource.create ( IdentityProviderRepresentation  representation )

inline

Create a new identity provider

引数

representation

JSON body

戻り値

                                                                          {
        this.auth.realm().requireManageIdentityProviders();

        try {
            IdentityProviderModel identityProvider = RepresentationToModel.toModel(realm, representation);
            this.realm.addIdentityProvider(identityProvider);

            representation.setInternalId(identityProvider.getInternalId());
            adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri(), identityProvider.getAlias())
                    .representation(StripSecretsUtils.strip(representation)).success();
            
            return Response.created(session.getContext().getUri().getAbsolutePathBuilder().path(representation.getAlias()).build()).build();
        } catch (ModelDuplicateException e) {
            return ErrorResponse.exists("Identity Provider " + representation.getAlias() + " already exists");
        }
    }

getIdentityProvider()

IdentityProviderResource org.keycloak.services.resources.admin.IdentityProvidersResource.getIdentityProvider ( @PathParam("alias") String  alias )

inline

                                                                                          {
        this.auth.realm().requireViewIdentityProviders();
        IdentityProviderModel identityProviderModel = null;

        for (IdentityProviderModel storedIdentityProvider : this.realm.getIdentityProviders()) {
            if (storedIdentityProvider.getAlias().equals(alias)
                    || storedIdentityProvider.getInternalId().equals(alias)) {
                identityProviderModel = storedIdentityProvider;
            }
        }

        IdentityProviderResource identityProviderResource = new IdentityProviderResource(this.auth, realm, session, identityProviderModel, adminEvent);
        ResteasyProviderFactory.getInstance().injectProperties(identityProviderResource);
        
        return identityProviderResource;
    }

getIdentityProviders() [1/2]

Response org.keycloak.services.resources.admin.IdentityProvidersResource.getIdentityProviders ( @PathParam("provider_id") String  providerId )

inline

Get identity providers

引数

providerId

Provider id

戻り値

                                                                                      {
        this.auth.realm().requireViewIdentityProviders();
        IdentityProviderFactory providerFactory = getProviderFactorytById(providerId);
        if (providerFactory != null) {
            return Response.ok(providerFactory).build();
        }
        return Response.status(BAD_REQUEST).build();
    }

getIdentityProviders() [2/2]

List<IdentityProviderRepresentation> org.keycloak.services.resources.admin.IdentityProvidersResource.getIdentityProviders ( )

inline

Get identity providers

戻り値

                                                                       {
        this.auth.realm().requireViewIdentityProviders();

        List<IdentityProviderRepresentation> representations = new ArrayList<IdentityProviderRepresentation>();

        for (IdentityProviderModel identityProviderModel : realm.getIdentityProviders()) {
            representations.add(StripSecretsUtils.strip(ModelToRepresentation.toRepresentation(realm, identityProviderModel)));
        }
        return representations;
    }

getProviderFactories()

List<ProviderFactory> org.keycloak.services.resources.admin.IdentityProvidersResource.getProviderFactories ( )

inlineprivate

                                                         {
        List<ProviderFactory> allProviders = new ArrayList<ProviderFactory>();

        allProviders.addAll(this.session.getKeycloakSessionFactory().getProviderFactories(IdentityProvider.class));
        allProviders.addAll(this.session.getKeycloakSessionFactory().getProviderFactories(SocialIdentityProvider.class));

        return allProviders;
    }

getProviderFactorytById()

IdentityProviderFactory org.keycloak.services.resources.admin.IdentityProvidersResource.getProviderFactorytById ( String  providerId )

inlineprivate

                                                                               {
        List<ProviderFactory> allProviders = getProviderFactories();

        for (ProviderFactory providerFactory : allProviders) {
            if (providerFactory.getId().equals(providerId)) {
                return (IdentityProviderFactory) providerFactory;
            }
        }

        return null;
    }

importFrom() [1/2]

Map<String, String> org.keycloak.services.resources.admin.IdentityProvidersResource.importFrom ( MultipartFormDataInput  input ) throws IOException

inline

Import identity provider from uploaded JSON file

引数

input

戻り値

例外

IOException

                                                                                           {
        this.auth.realm().requireManageIdentityProviders();
        Map<String, List<InputPart>> formDataMap = input.getFormDataMap();
        if (!(formDataMap.containsKey("providerId") && formDataMap.containsKey("file"))) {
            throw new BadRequestException();
        }
        String providerId = formDataMap.get("providerId").get(0).getBodyAsString();
        InputPart file = formDataMap.get("file").get(0);
        InputStream inputStream = file.getBody(InputStream.class, null);
        IdentityProviderFactory providerFactory = getProviderFactorytById(providerId);
        Map<String, String> config = providerFactory.parseConfig(session, inputStream);
        return config;
    }

importFrom() [2/2]

Map<String, String> org.keycloak.services.resources.admin.IdentityProvidersResource.importFrom ( Map< String, Object >  data ) throws IOException

inline

Import identity provider from JSON body

引数

data

JSON body

戻り値

例外

IOException

                                                                                       {
        this.auth.realm().requireManageIdentityProviders();
        if (!(data.containsKey("providerId") && data.containsKey("fromUrl"))) {
            throw new BadRequestException();
        }
        String providerId = data.get("providerId").toString();
        String from = data.get("fromUrl").toString();
        InputStream inputStream = session.getProvider(HttpClientProvider.class).get(from);
        try {
            IdentityProviderFactory providerFactory = getProviderFactorytById(providerId);
            Map<String, String> config;
            config = providerFactory.parseConfig(session, inputStream);
            return config;
        } finally {
            try {
                inputStream.close();
            } catch (IOException e) {
            }
        }
    }

メンバ詳解

adminEvent

AdminEventBuilder org.keycloak.services.resources.admin.IdentityProvidersResource.adminEvent

private

auth

AdminPermissionEvaluator org.keycloak.services.resources.admin.IdentityProvidersResource.auth

private

realm

final RealmModel org.keycloak.services.resources.admin.IdentityProvidersResource.realm

private

session

final KeycloakSession org.keycloak.services.resources.admin.IdentityProvidersResource.session

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/admin/IdentityProvidersResource.java