Jans CLI/TUI User Management#

Janssen Server provides command-line, text-based, and REST API interfaces for user management.

Using Command Line#

The Jans CLI provides command-line operations for creating, updating, and deleting users and managing user attributes.

Create a User#

The post-user operation creates a new user in Janssen Server. User information can be provided either in a JSON file or directly as JSON data.

Using a JSON File#

1. Create a JSON file containing the user attributes.

   {
     "userId": "testcliuser",
     "mail": "user@example.com",
     "userPassword": "<your-password>",
     "status": "active",
     "displayName": "Test User",
     "givenName": "Test"
   }
   

2. Run the post-user operation and provide the path to the JSON file:

   jans cli --operation-id post-user --data /path/to/user.json 
   

3. A successful request returns the details of the newly created user, including its assigned inum.

Using JSON Data#

You can also provide the user attributes directly with the --data option:

jans cli --operation-id post-user \
  --data '{
    "userId": "testcliuser",
    "givenName": "Test",
    "displayName": "Test User",
    "mail": "user@example.com",
    "userPassword": "your-password",
    "status": "active"
  }'

A successful request returns the details of the newly created user.

{
    "code": "400",
    "message": "USER_CREATION_ERROR",
    "description": "Attributes Missing in request are {displayName,givenName}."
}

Update a User#

The put-user operation updates an existing user in Janssen Server. User information can be provided either in a JSON file or directly as JSON data.

To update a user, include the user's inum and baseDn along with the user attributes.

Using a JSON File#

1. Create a JSON file containing the user's information:

   {
     "userId": "testcliuser",
     "givenName": "Updated",
     "displayName": "Updated Test User",
     "mail": "user@example.com",
     "status": "active",
     "inum": "<user-inum>",
     "baseDn": "<user-base-dn>"
   }
   

2. Run the put-user operation and provide the path to the JSON file:

   jans cli --operation-id put-user --data /path/to/user.json
   

3. A successful request returns the updated user information, including the updatedAt timestamp.

Using JSON Data#

You can also provide the user information directly with the --data option:

jans cli --operation-id put-user \
  --data '{
    "userId": "testcliuser",
    "givenName": "Updated",
    "displayName": "Updated Test User",
    "mail": "user@example.com",
    "status": "active",
    "inum": "<user-inum>",
    "baseDn": "<user-base-dn>"
  }'

A successful request returns the updated user information.

Add a Claim#

The put-user operation adds a claim to an existing user in Janssen Server. The claim is specified through the customAttributes field. The user's information, including inum and baseDn, must also be provided.

Using a JSON File#

1. Create a JSON file containing the user's information and the claim:

   {
     "userId": "testcliuser",
     "givenName": "Updated",
     "displayName": "Updated Test User",
     "mail": "cli-test-user@example.com",
     "status": "active",
     "inum": "<user-inum>",
     "baseDn": "<user-base-dn>",
     "customAttributes": [
       {
         "name": "phoneNumberVerified",
         "multiValued": false,
         "values": [true]
       }
     ]
   }
   

   The customAttributes field specifies the user attributes to add or update. The name specifies the claim name, multiValued specifies whether the claim can have multiple values, and values contains the claim value.

2. Run the put-user operation and provide the path to the JSON file:

   jans cli --operation-id put-user --data /path/to/user.json
   

3. A successful request returns the updated user information.

Using JSON Data#

You can also provide the user information and claim directly with the --data option:

jans cli --operation-id put-user \
  --data '{
    "userId": "testcliuser",
    "givenName": "Update given name",
    "displayName": "Updated display name",
    "mail": "cli-test-user@example.com",
    "status": "active",
    "inum": "<user-inum>",
    "baseDn": "<user-base-dn>",
    "customAttributes": [
      {
        "name": "phoneNumberVerified",
        "multiValued": false,
        "values": [true]
      }
    ]
  }'

A successful request returns the updated user information with the added claim.

Change Password#

The patch-user-by-inum operation changes the password of an existing user in Janssen Server. The user is identified by inum, and the new password is provided through the customAttributes field.

The password can be provided either in a JSON file or directly as JSON data.

Using a JSON File#

1. Create a JSON file containing the new password:

   {
     "jsonPatchString": "",
     "customAttributes": [
       {
         "name": "userPassword",
         "multiValued": false,
         "value": "your-new-password"
       }
     ]
   }
   

2. Run the patch-user-by-inum operation and provide the user's inum and the path to the JSON file:

   jans cli --operation-id patch-user-by-inum --url-suffix "inum:<user-inum>" --data /path/to/user.json
   

3. A successful request returns the updated user information, including the updatedAt timestamp.

Using JSON Data#

You can also provide the new password directly with the --data option:

jans cli --operation-id patch-user-by-inum \
  --url-suffix "inum:<user-inum>" \
  --data '{
    "jsonPatchString": "",
    "customAttributes": [
      {
        "name": "userPassword",
        "multiValued": false,
        "value": "your-new-password"
      }
    ]
  }'

A successful request returns the updated user information.

Delete User#

The delete-user operation deletes an existing user from Janssen Server. The user is identified by their inum.

1. Run the delete-user operation and provide the user's inum:

   jans cli --operation-id delete-user --url-suffix "inum:<user-inum>"
   

2. A successful request returns:

Object was successfully deleted.

Using Text-based UI#

Jans TUI provides user-management operations from the terminal. For instructions on adding, updating, deleting, and managing users with Jans TUI, see Using Text-based UI.

Using Configuration REST API#

Janssen Server Configuration REST API exposes relevant endpoints for managing and configuring the user. Endpoint details are published in the Swagger document.