Skip to content

Commit

Permalink
feat(jans-config-api): user mgmt endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
@pujavs
pujavs committed Mar 31, 2022
1 parent f98c59e commit 379ca09
Show file tree
Hide file tree
Showing 2 changed files with 234 additions and 20 deletions.
219 changes: 205 additions & 14 deletions jans-config-api/docs/jans-config-api-swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ tags:
- name: Statistics - User
- name: Health - Check
- name: Server Stats
- name: User Management
- name: SCIM - User Management
- name: SCIM - Config Management
- name: Organization Configuration
Expand Down Expand Up @@ -2396,6 +2397,193 @@ paths:
$ref: '#/components/schemas/StatsData'
'500':
description: Internal Server Error
/jans-config-api/api/v1/user:
get:
tags:
- User Management
summary: Gets list of users
description: Gets list of users
operationId: get-user
responses:
'200':
description: OK
content:
application/json:
schema:
title: Users.
description: List of users.
items:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal Server Error
security:
- oauth2: [https://jans.io/oauth/config/user.readonly]
parameters:
- schema:
type: integer
default: 50
in: query
name: limit
description: Search size - max size of the results to return.
- schema:
type: string
in: query
name: pattern
description: Search pattern.
- schema:
type: integer
default: 1
in: query
name: startIndex
description: The 1-based index of the first query result.
- schema:
type: string
default: inum
in: query
name: sortBy
description: Attribute whose value will be used to order the returned response.
- schema:
type: string
default: ascending
enum:
- ascending
- descending
in: query
name: sortOrder
description: Order in which the sortBy param is applied. Allowed values are "ascending" and "descending".
post:
tags:
- User Management
summary: Create new User
description: Create new User
operationId: post-user
requestBody:
content:
application/json:
schema:
title: User Details.
description: User Details.
$ref: '#/components/schemas/User'
responses:
'201':
description: Created
content:
application/json:
schema:
title: User Details.
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal Server Error
security:
- oauth2: [https://jans.io/oauth/config/user.write]
put:
tags:
- User Management
summary: Update User.
description: Update User.
operationId: put-user
requestBody:
content:
application/json:
schema:
title: User Details.
$ref: '#/components/schemas/User'
responses:
'200':
description: OK
content:
application/json:
schema:
title: User Details.
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
description: Internal Server Error
security:
- oauth2: [https://jans.io/oauth/config/user.write]
/jans-config-api/api/v1/user/{inum}:
parameters:
- schema:
type: string
name: inum
in: path
description: User identifier
required: true
get:
tags:
- User Management
summary: Get User by Inum
description: Get User by Inum.
operationId: get-user-by-inum
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal Server Error
security:
- oauth2: [https://jans.io/oauth/config/user.readonly]
delete:
tags:
- User Management
summary: Delete User.
description: Delete User.
operationId: delete-user
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
description: Internal Server Error
security:
- oauth2: [https://jans.io/oauth/config/user.delete]
patch:
tags:
- User Management
summary: Update modified properties of user by Inum.
description: Update modified properties of user by Inum.
operationId: patch-user-by-inum
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/PatchRequest'
description: String representing patch-document.
example: '[ {op:replace, path: userId, value: test_user_100 } ]'
responses:
'200':
description: OK
content:
application/json:
schema:
title: User Details.
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
description: Internal Server Error
security:
- oauth2: [https://jans.io/oauth/config/user.write]

/jans-config-api/scim/user:
get:
Expand Down Expand Up @@ -3433,6 +3621,10 @@ components:
https://jans.io/scim/config.write: Manage SCIM App configuration
https://jans.io/oauth/config/organization.readonly: View organization configuration information
https://jans.io/oauth/config/organization.write: Manage organization configuration information
https://jans.io/oauth/config/user.readonly: View user related information
https://jans.io/oauth/config/user.write: Manage user related information
https://jans.io/oauth/config/user.delete: Delete user related information


responses:
Found:
Expand Down Expand Up @@ -6292,7 +6484,7 @@ components:
description: A human readable name, primarily used for display purposes.
type: string
type:
description: 'A label indicating the attribute's function; e.g., 'work' or 'home'.'
description: A label indicating the attribute's function; e.g., 'work' or 'home'.
type: string
example: work
primary:
Expand Down Expand Up @@ -6344,7 +6536,7 @@ components:
description: A human readable name, primarily used for display purposes.
type: string
type:
description: 'A label indicating the attribute's function; e.g., 'photo' or 'thumbnail'.'
description: A label indicating the attribute's function; e.g., 'photo' or 'thumbnail'.
type: string
example: thumbnail
primary:
Expand Down Expand Up @@ -6375,7 +6567,7 @@ components:
description: Country expressed in ISO 3166-1 "alpha-2" code format
example: UK
type:
description: 'A label indicating the attribute's function; e.g., 'work' or 'home'.'
description: A label indicating the attribute's function; e.g., 'work' or 'home'.
type: string
example: home
primary:
Expand Down Expand Up @@ -6806,7 +6998,7 @@ components:
mail:
description: Primary Email Address.
type: string
memberOf:
memberOf:
description: Groups with which a person is associated.
type: array
items:
Expand Down Expand Up @@ -6857,19 +7049,19 @@ components:
items:
$ref: '#/components/schemas/Entitlement'
extId:
description: 'User's external id.'
description: User's external id.
type: string
imsValue:
description: Instant messaging address value.
type: array
items:
$ref: '#/components/schemas/InstantMessagingAddress'
created:
description: 'Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating creation time.'
description: Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating creation time.
type: string
format: date-time
lastModified:
description: 'Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating last modified time.'
description: Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating last modified time.
type: string
format: date-time
location:
Expand Down Expand Up @@ -6954,11 +7146,11 @@ components:
description: Date of birth of the user. Year of birth (four digits),Month of birth (1-12),Day of birth
type: string
format: date-time
timezone:
timezone:
description: Time zone database representing the End-Usrs time zone. For example, Europe/Paris or America/Los_Angeles
type: string
example: America/Los_Angeles
locale:
locale:
description: Locale of the person, represented as a BCP47 [RFC5646] language tag. Used for purposes of localizing items such as currency and dates.
type: string
example: en-US
Expand Down Expand Up @@ -7001,14 +7193,13 @@ components:
userPassword:
description: user password
type: string
st:
state:
description: State or Province
type: string
street:
type: string
l:
st:
description: State or Province
city:
description: Locality Name or city
type: string
countInvalidLogin:
description: Invalid login attempts count
Expand All @@ -7020,7 +7211,7 @@ components:
description: This data has information about your imap connection
type: string
ppid:
description: Persistent Pairwise ID for OpenID Connect
description: Persistent Pairwise ID for OpenID Connect
type: array
items:
type: string
Expand Down
35 changes: 29 additions & 6 deletions jans-config-api/server/src/main/java/io/jans/configapi/rest/resource/auth/UserResource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
import com.github.fge.jsonpatch.JsonPatchException;
import static io.jans.as.model.util.Util.escapeLog;
import io.jans.as.common.model.common.User;
import io.jans.as.common.model.registration.Client;
import io.jans.as.common.service.common.EncryptionService;
import io.jans.configapi.core.rest.ProtectedApi;
import io.jans.configapi.rest.model.SearchRequest;
import io.jans.configapi.service.auth.UserService;
Expand All @@ -30,7 +32,7 @@
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;


import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;

@Path(ApiConstants.USER)
Expand All @@ -44,6 +46,9 @@ public class UserResource extends BaseResource {
@Inject
Logger logger;

@Inject
EncryptionService encryptionService;

@Inject
UserService userSrv;

Expand All @@ -68,7 +73,7 @@ public Response getOpenIdConnectClients(

final List<User> users = this.doSearch(searchReq);
logger.error("User serach result:{}", users);
return Response.ok(users).build();
return Response.ok(getUsers(users)).build();
}

@GET
Expand All @@ -89,8 +94,7 @@ public Response createOpenIdConnect(@Valid User user) throws EncryptionException
if (logger.isDebugEnabled()) {
logger.debug("User details to be added - user:{}", escapeLog(user));
}

user = userSrv.addUser(user, true);
user = userSrv.addUser(encryptUserPassword(user), true);
logger.error("User created {}", user);
return Response.status(Response.Status.CREATED).entity(user).build();
}
Expand All @@ -100,8 +104,8 @@ public Response createOpenIdConnect(@Valid User user) throws EncryptionException
public Response updateUser(@Valid User user) throws EncryptionException {
if (logger.isDebugEnabled()) {
logger.debug("User details to be updated - user:{}", escapeLog(user));
}
user = userSrv.updateUser(user);
}
user = userSrv.updateUser(encryptUserPassword(user));
logger.debug("Updated user:{}", user);

return Response.ok(user).build();
Expand Down Expand Up @@ -158,4 +162,23 @@ private List<User> doSearch(SearchRequest searchReq) {
return users;
}

private List<User> getUsers(List<User> users) throws EncryptionException {
if (users != null && !users.isEmpty()) {
for (User user : users) {
if (StringUtils.isNotBlank(user.getAttribute("userPassword"))) {
user.setAttribute("userPassword", encryptionService.decrypt(user.getAttribute("userPassword")),
false);
}
}
}
return users;
}

private User encryptUserPassword(User user) throws EncryptionException {
if (StringUtils.isNotBlank(user.getAttribute("userPassword"))) {
user.setAttribute("userPassword", encryptionService.encrypt(user.getAttribute("userPassword")), false);
}
return user;
}

}

0 comments on commit 379ca09

Please sign in to comment.