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

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

公開メンバ関数
	UsersResource (RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)
Response	createUser (final UserRepresentation rep)
UserResource	user (final @PathParam("id") String id)
List< UserRepresentation >	getUsers (@QueryParam("search") String search, @QueryParam("lastName") String last, @QueryParam("firstName") String first, @QueryParam("email") String email, @QueryParam("username") String username, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults, @QueryParam("briefRepresentation") Boolean briefRepresentation)
Integer	getUsersCount ()

限定公開変数類
RealmModel	realm
ClientConnection	clientConnection
KeycloakSession	session
HttpHeaders	headers

非公開変数類
AdminPermissionEvaluator	auth
AdminEventBuilder	adminEvent

静的非公開変数類
static final Logger	logger = Logger.getLogger(UsersResource.class)
static final String	SEARCH_ID_PARAMETER = "id:"

詳解

Base resource for managing users

Users

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

UsersResource()

org.keycloak.services.resources.admin.UsersResource.UsersResource ( RealmModel  realm, AdminPermissionEvaluator  auth, AdminEventBuilder  adminEvent  )

inline

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

関数詳解

createUser()

Response org.keycloak.services.resources.admin.UsersResource.createUser ( final UserRepresentation  rep )

inline

Create a new user

Username must be unique.

引数

rep

戻り値

                                                             {
        auth.users().requireManage();

        // Double-check duplicated username and email here due to federation
        if (session.users().getUserByUsername(rep.getUsername(), realm) != null) {
            return ErrorResponse.exists("User exists with same username");
        }
        if (rep.getEmail() != null && !realm.isDuplicateEmailsAllowed() && session.users().getUserByEmail(rep.getEmail(), realm) != null) {
            return ErrorResponse.exists("User exists with same email");
        }

        try {
            UserModel user = session.users().addUser(realm, rep.getUsername());
            Set<String> emptySet = Collections.emptySet();

            UserResource.updateUserFromRep(user, rep, emptySet, realm, session, false);
            RepresentationToModel.createCredentials(rep, session, realm, user, true);
            adminEvent.operation(OperationType.CREATE).resourcePath(session.getContext().getUri(), user.getId()).representation(rep).success();

            if (session.getTransactionManager().isActive()) {
                session.getTransactionManager().commit();
            }

            return Response.created(session.getContext().getUri().getAbsolutePathBuilder().path(user.getId()).build()).build();
        } catch (ModelDuplicateException e) {
            if (session.getTransactionManager().isActive()) {
                session.getTransactionManager().setRollbackOnly();
            }
            return ErrorResponse.exists("User exists with same username or email");
        } catch (ModelException me){
            if (session.getTransactionManager().isActive()) {
                session.getTransactionManager().setRollbackOnly();
            }
            logger.warn("Could not create user", me);
            return ErrorResponse.exists("Could not create user");
        }
    }

getUsers()

List<UserRepresentation> org.keycloak.services.resources.admin.UsersResource.getUsers ( @QueryParam("search") String  search, @QueryParam("lastName") String  last, @QueryParam("firstName") String  first, @QueryParam("email") String  email, @QueryParam("username") String  username, @QueryParam("first") Integer  firstResult, @QueryParam("max") Integer  maxResults, @QueryParam("briefRepresentation") Boolean  briefRepresentation  )

inline

Get users

Returns a list of users, filtered according to query parameters

引数

search	A String contained in username, first or last name, or email
last
first
email
username
first	Pagination offset
maxResults	Maximum results size (defaults to 100)

戻り値

                                                                                                             {
        auth.users().requireQuery();

        firstResult = firstResult != null ? firstResult : -1;
        maxResults = maxResults != null ? maxResults : Constants.DEFAULT_MAX_RESULTS;

        List<UserRepresentation> results = new ArrayList<UserRepresentation>();
        List<UserModel> userModels = Collections.emptyList();
        if (search != null) {
            if (search.startsWith(SEARCH_ID_PARAMETER)) {
                UserModel userModel = session.users().getUserById(search.substring(SEARCH_ID_PARAMETER.length()).trim(), realm);
                if (userModel != null) {
                    userModels = Arrays.asList(userModel);
                }
            } else {
                userModels = session.users().searchForUser(search.trim(), realm, firstResult, maxResults);
            }
        } else if (last != null || first != null || email != null || username != null) {
            Map<String, String> attributes = new HashMap<String, String>();
            if (last != null) {
                attributes.put(UserModel.LAST_NAME, last);
            }
            if (first != null) {
                attributes.put(UserModel.FIRST_NAME, first);
            }
            if (email != null) {
                attributes.put(UserModel.EMAIL, email);
            }
            if (username != null) {
                attributes.put(UserModel.USERNAME, username);
            }
            userModels = session.users().searchForUser(attributes, realm, firstResult, maxResults);
        } else {
            userModels = session.users().getUsers(realm, firstResult, maxResults, false);
        }

        boolean canViewGlobal = auth.users().canView();
        boolean briefRepresentationB = briefRepresentation != null && briefRepresentation;
        for (UserModel user : userModels) {
            if (!canViewGlobal  && !auth.users().canView(user)) continue;
            UserRepresentation userRep = briefRepresentationB
              ? ModelToRepresentation.toBriefRepresentation(user)
              : ModelToRepresentation.toRepresentation(session, realm, user);
            userRep.setAccess(auth.users().getAccess(user));
            results.add(userRep);
        }
        return results;
    }

getUsersCount()

Integer org.keycloak.services.resources.admin.UsersResource.getUsersCount ( )

inline

                                   {
        auth.users().requireView();

        return session.users().getUsersCount(realm);
    }

user()

UserResource org.keycloak.services.resources.admin.UsersResource.user ( final @PathParam("id") String  id )

inline

Get representation of the user

引数

id

User id

戻り値

                                                               {
        UserModel user = session.users().getUserById(id, realm);
        if (user == null) {
            // we do this to make sure somebody can't phish ids
            if (auth.users().canQuery()) throw new NotFoundException("User not found");
            else throw new ForbiddenException();
        }
        UserResource resource = new UserResource(realm, user, auth, adminEvent);
        ResteasyProviderFactory.getInstance().injectProperties(resource);
        //resourceContext.initResource(users);
        return resource;
    }

メンバ詳解

adminEvent

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

private

auth

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

private

clientConnection

ClientConnection org.keycloak.services.resources.admin.UsersResource.clientConnection

protected

headers

HttpHeaders org.keycloak.services.resources.admin.UsersResource.headers

protected

logger

final Logger org.keycloak.services.resources.admin.UsersResource.logger = Logger.getLogger(UsersResource.class)

staticprivate

realm

RealmModel org.keycloak.services.resources.admin.UsersResource.realm

protected

SEARCH_ID_PARAMETER

final String org.keycloak.services.resources.admin.UsersResource.SEARCH_ID_PARAMETER = "id:"

staticprivate

session

KeycloakSession org.keycloak.services.resources.admin.UsersResource.session

protected

---

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

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