The Identity Service Deployment Script offered for Unix Shell can be applied to perform frequently used operations to mange manage accounts, roles and and JS7 - Identity Services.

Identity Service Deployment Script

Command	Category	Documentation
get-account / store-account	Accounts	JS7 - Management of User Accounts, Roles and Permissions JS7 - Manage User Accounts
rename-account / remove-account
get-account-permission
set-account-password / reset-account-password
enable-account / disable-account
block-account / unblock-account
get-role / store-role	Roles	JS7 - Management of User Accounts, Roles and Permissions JS7 - Manage Roles and Permissions JS7 - Default Roles and Permissions
rename-role / remove-role	Roles
get-permission / set-permission	Permissions
rename-permission / remove-permission	Permissions
get-folder / set-folder	Folder Permissions
rename-folder / remove-folder	Folder Permissions
get-service / store-service	Identity Services	JS7 - Identity Services
rename-service / remove-service
get-service-settings / store-service-settings

The script is offered for download and can be applied for frequently used operations:

...

Code Block

title	Usage

Usage: deploy-identity-service.sh [Command] [Options] [Switches]

  Commands:
    get-account             --service [--account] [--enabled] [--disabled] [--blocked]
    store-account           --service  --account  [--role] [--disabled] [--account-password] [--force-password-change]
    rename-account          --service  --account   --new-account
    remove-account          --service  --account  [--enabled] [--disabled]
    get-account-permission  --service  --account
    set-account-password    --service  --account   --account-password --new-account-password
    reset-account-password  --service  --account
    enable-account          --service  --account
    disable-account         --service  --account
    block-account           --service  --account [--comment]
    unblock-account         --service  --account

    get-role                --service [--role]
    store-role              --service  --role [--ordering]
    rename-role             --service  --role  --new-role
    remove-role             --service  --role

    get-permission          --service  --role [--controller-id]
    set-permission          --service  --role  --permission [--excluded] [--controller-id]
    rename-permission       --service  --role  --permission  --new-permission [--excluded] [--controller-id]
    remove-permission       --service  --role  --permission [--controller-id]

    get-folder              --service  --role [--folder] [--controller-id]
    set-folder              --service  --role  --folder  [--recursive] [--controller-id]
    rename-folder           --service  --role  --folder   --new-folder [--recursive] [--controller-id]
    remove-folder           --service  --role  --folder  [--controller-id]

    get-service            [--service]
    store-service           --service --service-type [--ordering] [--required] [--disabled]
                           [--authentication-scheme] [--singlesecond-factor-certificate] [--single-factor-password]service]
    rename-service          --service --new-service
    remove-service          --service

  Options:
   get-service-settings    --service --service-type
    store-service-settings  --service --service-type --settings

  Options:
    --url=<url>                        | required: JOC Cockpit URL
    --user=<account>                   | required: JOC Cockpit user account
    --password=<password>              | optional: JOC Cockpit password
    --ca-cert=<path>                   | optional: path to CA Certificate used for JOC Cockpit login
    --client-cert=<path>               | optional: path to Client Certificate used for login
    --client-key=<path>                | optional: path to Client Key used for login
    --timeout=<seconds>                | optional: timeout for request, default: 60
    --controller-id=<id>               | optional: Controller ID
    --account=<name[,name]>            | optional: list of accounts
    --new-account=<name[,name]>        | optional: new account names
    --account-password=<password>      | optional: password for account
    --new-password=<password>          | optional: new password for account
    --service=<name>                   | required: Identity Service name
    --service-type=<id>                | optional: Identity Service type such as JOC, LDAP, LDAP-JOC, OIDC, OIDC-JOC
    --ordering=<number>                | optional: ordering of Identity Service or role by ascending number
    --new-service=<name>               | optional: new Identity Service name
    --second-service=<name>            | optional: second Identity Service for MFA
    --authentication-scheme=<factor>   | optional: Identity Service authentication scheme: SINGLE-FACTOR, TWO-FACTOR
    --role=<name[,name]>settings=<json>                  | optional: listIdentity ofService roles
settings in JSON format
    --role=<name[,name]>               | optional: list of roles
    --new-role=<name>                  | optional: new role name
    --permission=<id[,id]>             | optional: list of permission identifiers assigned a role
    --new-permission=<id>              | optional: new permission identifier assigned a role
    --folder=<name[,name]>             | optional: list of folders assigned a role
    --new-folder=<name>                | optional: new folder assigned a role
    --audit-message=<string>           | optional: audit log message
    --audit-time-spent=<number>        | optional: audit log time spent in minutes
    --audit-link=<url>                 | optional: audit log link
    --log-dir=<directory>              | optional: path to directory holding the script's log files

  Switches:
    -h | --help                        | displays usage
    -v | --verbose                     | displays verbose output, repeat to increase verbosity
    -p | --password                    | asks for password
    -a | --account-password            | asks for account password
    -n | --new-password                | asks for new account password
    -f | --force-password-change       | enforces password change on next login
    -e | --enabled                     | filters for enabled accounts
    -d | --disabled                    | filters for disabled accounts or disables Identity Services
    -b | --blocked                     | filters for blocked accounts
    -x | --excluded                    | sets excluded permissions
    -q | --required                    | enforces use of Identity Service
    -r | --recursive                   | applies folder operation to sub-folders
    --singleshow-factor-certificatelogs        | certificate allowed as single factor
    --single-factor-password           | password allowed as single factor
    --show-logs                        | | shows log output if --log-dir is used
    --make-dirs                        | creates directories if they do not exist

see https://kb.sos-berlin.com/x/lwTWCQ

...

Operations on accounts are available to Identity Services that hold account information using the service types JOC, KEYCLOAK-JOC, LDAP-JOC, OIDC-JOC, CERTIFICATE and FIDO service types. For Identity Services that manage accounts on their own such as KEYCLOAK, LDAP, OIDC, the JOC Cockpit does not provide account information. For details see JS7 - Identity Services.

get-account
- Returns information about the indicated account or all accounts if the --account option is not specified.
- Accounts can be filtered:
  - The --enabled switch will filter results to active accounts
  - The --disabled switch will filter results to inactive accounts.
  - The --blocked switch will filter results to accounts that are blocked. The switch cannot be used with the --enabled and --disabled switches.
store-account
- Stores an account to the Identity Service.
  - An existing role can be assigned using the --role option.
  - The password can be specified using the --account-password option. Consider to use secure input from the commandline using the -a switch. If no password is specified then the initial password is assigned. If a password is specified or the initial password is used, then JOC Cockpit will challenge the user to specify a new password on next login.
  - The --force-password-change switch can be used to make JOC Cockpit challenge the user to specify a new password on next login. The operation is available for existing accounts that hold a password. For new accounts and for accounts assigned a new password users are automatically challenged to specify a new password on next login.
  - The --disabled switch can be used to deactivate an account when it is created. For later enabling/disabling of existing accounts see enable-account and disable-account commands.
- Handling of passwords allows the API user to specify passwords for other accounts. However, for the affected account accounts users will have to change the password on next login.
rename-account
- Renames the indicated account.
remove-account
- Removes the indicated account from the Identity Service.
get-account-permission
- Returns the list of permissions per role assigned the given account.
set-account-password
- Sets the password for the indicated account. Consider to use secure input from the commandline using the -a switch.
- The user will be challenged to specify a new password on next login.
reset-account-password
- Resets the account's password to the initial password.
- The user will be challenged to specify a new password on next login.
enable-account
- Activates the account which allows login to JOC Cockpit.
disable-account
- Deactivates the account which denies login to JOC Cockpit.

Roles

getblock-roleaccount
- Adds the account to the blocklist. The account will be denied login to JOC Cockpit.
- A comment can be specified to indicate the reason for blocking the account.
unblock-account
- Removes one or more accounts from the blocklist. The accounts will be allowed login to JOC Cockpit if they are activated/enabled.

Roles

get-role
- Returns the indicated role if the --role option Returns the indicated role if the --role option is used and otherwise returns all roles.
store-role
- Stores a role from its name to JOC Cockpit. Default permissions will be applied to new roles.
- The --ordering option can be used to specify the position of the role in the list of roles available for the given Identity Service.
rename-role
- Renames an existing role.
remove-role
- Removes the indicated role from the Identity Service.

...

get-permission
- Returns permissions of the indicated role.
set-permission
- Assigns the a role one or more permission permissions that are specified from permission identifiers using the --permission option. If more than one permission identifier is used, then they are separated by comma, for example example --permission='sos:products:controller:view','sos:products:controller:agents:view'. Use of single quotes or double quotes is recommended.
- Permissions can be preceeded a minus to indicate that the permission is denied, for example: --permission='-sos:products:controller:view'. This corrresponds to use of the --excluded switch, but allows to allow/deny permissions individually.
- If the --excluded switch is used, then indicated permissions are denied. This applies to JOC Cockpit and to all Controllers for If the --excluded switch is used, then permissions are denied. This applies to JOC Cockpit and to all Controllers for which the indicated permissions will be denied.
- The Controller ID can be specified using the --controller-id option to limit permissions to the given Controller.
rename-permission
- Switches an existing permission to a different permission.
remove-permission
- Removes the indicated permission permissions from the role. One or more permissions can be specified separated by comma.

Folder Permissions

Folder permissions are used to apply permissions to certain folders in the JOC Cockpit inventory and to limit user access to folders. If no folder permissions are specified, then users have access to all inventory folders.

For default permissions and permission identifiers see JS7 - Default Roles and Permissions.

...

get-service
- If the --service option is used, returns the indicated Identity Service and otherwise returns the list of Identity Services.
store-service
- Stores the indicated Identity Service.
- The following options and switches can be used:
  - The --service-type option specifies the capabilities of the Identity Service such as LDAP, OIDC, FIDO. For the full list of service types see JS7 - Identity Services, Matrix.
  - The --required switch specifies that successful authentication using the Identity Service is required. If the switch is not used, then JOC Cockpit will switch to using the next Identity Service in case of unsuccessful authentication.
  - The --disabled switch can be used to deactivate an Identity Serivce which denies login by any accounts using the Identity Service.
  - The --ordering option can be used to specifiy the position of the Identity Service in the list of Identity Services.
  - The --authenticationsecond-scheme option allows to specify the following values: SINGLE-FACTOR, TWO-FACTOR.Single-factor authentication specifies that the Identity Service is used as a single factor for authenticationservice option specifies a second Identity Service for multi-factor authentication. Use of this option implicitly specifies the --authentication-scheme=TWO-FACTOR option.
  - The --authentication-scheme option allows to specify the following values: SINGLE-FACTOR, TWO-FACTOR.
    - Single-factor authentication specifies that the Identity Service is used as a single-factor-certificate switch is used for the JS7 - Certificate Identity Service to specify that a certificate acts as the single factor for authentication.The --single-factor-password switch is used to specify that a password is used as the single factor for authentication.
    - Two-factor authentication specifies that a second Identity Service is used and that successful authentication with both Identity Services is required. For example an Identity Serivce using the LDAP service type can use FIDO as a second factor. This implies that secrets are stored on different media: the LDAP password is stored with the user's brain while the FIDO secret is stored on the user's device, for example on a USB key or in an authenticator application on a smartphone.
rename-service
- Renames the indicated Identity Service.
remove-service
- Removes the indicated Identity Service and related objects such as roles, permissions, folder permissions and accounts recursively.
- Users should check that there is a remaining after removal an Identity Service remains that allows to login. To restore access to JOC Cockpit consider JS7 - Rescue in case of lost access to JOC Cockpit.

Options

get-service-url
- Specifies the URL by which JOC Cockpit is accessible using <http|https>://<host>:<port>.
- Example: http://centostest-primary.sos:4446
- Example: https://centostest-primary.sos:4443
settings
- Returns settings from an Identity Service. For example, the LDAP, OIDC and FIDO Identity Services hold confiugration items with their service settings.
- Settings are returned in JSON format and can be stored to environment variables or to files, for example
  - settings=$(./deploy-identity-service.sh get-service-settings "${request_options[@]}" --service=My-Service --service-type=LDAP)
  - ./deploy-identity-service.sh get-service-settings "${request_options[@]}" --service=My-Service --service-type=LDAP > /tmp/ldap.settings.json
store-service-settings
- Stores Identity Service settings that have previously been retrieved using the get-service-settings command.
- Settings are expected in JSON format from the value of the --settings option. If settings have previously been stored to a file, then they can be assigned like this:
  - settings=$(cat ./examples/ldap-settings.json)
  - ./deploy-identity-service.sh get-service-settings ... --settings="$settings"

Options

--url
- Specifies the URL by which JOC Cockpit is accessible using <http|https>://<host>:<port>.
- Example: http://centostest-primary.sos:4446
- Example: https://centostest-primary.sos:4443
--user
- Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the --client-cert and --client-key options then their common name (CN) attribute has to match the user account.
- If a user account is specified then a password can be specified using the --password option or interactive keyboard input can be prompted using the -p switch.
--password
- Specifies the password used for the account specified with the --user option for login to JOC Cockpit.
- Password input from the command line
--user
- Specifies the user account for login to JOC Cockpit. If JS7 - Identity Services are available for Client authentication certificates that are specified with the --client-cert and --client-key options then their common name (CN) attribute has to match the user account.
- If a user account is specified then a password can be specified using the --password option or interactive keyboard input can be prompted using the -p switch.
--password
- Specifies the password used for the account specified with the --user option for login to JOC Cockpit.
- Password input from the command line is considered insecure. Consider use of the -p switch offering a secure option for interactive keyboard input.
--ca-cert
- Specifies the path to a file in PEM format that holds the Root CA Certificate and optionally Intermediate CA Certificates to verify HTTPS connections to JOC Cockpit.
--client-cert
- Specifies the path to a file in PEM format that holds the Client Certificate if HTTPS mutual authentication is used..
--client-key
- Specifies the path to a file in PEM format that holds the Client Private Key if HTTPS mutual authentication is used..
--timeout
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default: 60 seconds.
--controller-id
- Specifies the identification of the Controller.
--account
- When used with commands on accounts, specifies the related account.
- When used with the remove-account, reset-account-password, enable-account and disable-account commands, one or more accounts can be specified separated by commea, for example:: --account=user1,user2.
--new-account
- When used with the rename-account command, specifies the new name of the account.
--account-password
- When used with the store-account and set-account-password commands, specifies the account's password.
- Command line input for passwords is considered insecure. Consider use of the -p switch offering a switch secure option for secure interactive interactive keyboard input for passwords.
--newca-password
- When used with the set-account-password commands, specifies the account's new password.
- Command line input for passwords is considered insecure. Consider use of the -n switch for secure interactive keyboard input for passwords.
--service
- Specifies the name of the Identity Service.
--service-type
- The option specifies the capabilities of the Identity Service such as LDAP, OIDC, FIDO. For the full list of service types see JS7 - Identity Services, Matrix.
--ordering
- When used with the store-role command, specifies the role's position in the list of roles. If the option is not used, then a newly added role will be appended.
- When used with the store-service command, specifies the Identity Service's position in the list of Identity Services. The ordering of Identity Services specifies the sequence by which Identity Services will be triggered if more than one Identity Service is used for authentication.
cert
- Specifies the path to a file in PEM format that holds the Root CA Certificate and optionally Intermediate CA Certificates to verify HTTPS connections to JOC Cockpit.
--client-cert
- Specifies the path to a file in PEM format that holds the Client Certificate if HTTPS mutual authentication is used..
--client-key
- Specifies the path to a file in PEM format that holds the Client Private Key if HTTPS mutual authentication is used..
--timeout
- Specifies the maximum duration for requests to the JS7 REST Web Service. Default: 60 seconds.
--controller-id
- Specifies the identification of the Controller.
--account
- When used with commands on accounts, specifies the related account.
- When used with the remove-account, reset-account-password, enable-account and disable-account commands, one or more accounts can be specified separated by comma, for example:: --account=user1,user2.
--new-account
- When used with the rename-account command, specifies the new name of the account.
--account-password
- When used with the store-account and set-account-password commands, specifies the account's password.
- Command line input for passwords is considered insecure. Consider use of the -a switch for secure interactive keyboard input for passwords.
--new-password
- When used with the set-account-password command, specifies the account's new password.
- Command line input for passwords is considered insecure. Consider use of the -n switch for secure interactive keyboard input for passwords.
--service
- Specifies the
--new-service
- When used with the rename-service command, specifies the new name of the Identity Service.
--authenticationservice-schemetype
- The option specifies the capabilities of the Identity Service such as LDAP, OIDC, FIDO. For the full list of service types see JS7 - Identity Services, Matrix
- When used with the store-service command, specifies single-factor or two-factor authentication using one of the values: SINGLE-FACTOR, TWO-FACTOR.
--role
- For role-based or permission-based command specifies the name of a role.
- If more than one role is specified, then they are separated by comma, for example: --role=administrator,business-user.
--new-role
- When used with the rename-role command, specifies the new name of the role.
--permission
- When used with the set-permission, rename-permission and remove-permission commands, specifies the permission identifiers to be used. For available permission identifiers see JS7 - Default Roles and Permissions.
- If more than one permission is used, then permission identifiers are separated by comma, for example: --permission='sos:products:controller:view','sos:products:controller:agents:view'.
ordering
- When used with the store-role command, specifies the role's position in the list of roles. If the option is not used, then a newly added role will be appended.
- When used with the store-service command, specifies the Identity Service's position in the list of Identity Services. The ordering of Identity Services specifies the sequence by which Identity Services will be triggered if more than one Identity Service is used for authentication.
--new-service--new-permission
- When used with the rename-permissionservice command, specifies the new permission identifiername of the Identity Service.
--second-folder
- Specifies the folder to which permissions are applied and that limit user access to JOC Cockpit inventory folders.
- If more than one folder is used, then they are separated by comma, for example --folder=/accounting,/reporting.
service
- When used with the store-service command, specifies the identifier of a second Identity Service that is used for multi-factor authentication (MFA).
- Use of the option requires to specify the --authentication-scheme option with the value TWO-FACTOR.
--authentication-scheme--new-folder
- When used with the renamestore-folder command, specifies the new permission identifier.
--audit-message
- Specifies a message that is made available to the Audit Log.
- Specification of Audit Log messages can be enforced on a per user basis and for a JS7 environment.
--audit-time-spent
- Specifies the time spent to perform an operation which is added to the Audit Log.
- The option can be specified if the --audit-message option is used.
--audit-link
- Specifies a link (URL) which is added to the Audit Log.
- The option can be specified if the --audit-message option is used.
--log-dir
- If a log directory is specified then the script will log information about processing steps to a log file in this directory.
- File names are created according to the pattern: operate-joc.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example: operate-joc.2022-03-19T20-50-45.log

Switches

-h | --help
- Displays usage.
-v | --verbose
- Displays verbose log output that includes requests and responses with the JS7 REST Web Service.
- When used twice as with -v -v then curl verbose output will be displayed.
-p | --password
- Asks the user for interactive keyboard input of the password used for the account specified with the --user option..
- The switch is used for secure interactive input as an alternative to use of the option --password=<password>.
-a | --account-password
- When used with the store-account and set-account-password commands, asks the user for interactive keyboard input of the existing password used for the account.
- The switch is used for secure interactive input as an alternative to use of the --account-password=<password> option.
-n | --new-password
- When used with the set-account-password command, asks the user for interactive keyboard input of the new password used for the account.
- The switch is used for secure interactive input as an alternative to use of the --new-account-password=<password> option.
-f | --force-password-change
- When used with the store-account command, specifies that the user will be challenged to type a new password on next login.
- The switch is used for existing accounts. Use of the switch is not required in the following situations that will automatically challenge the user to specify a new password on next login:
  - For new accounts using the initial passwords and for accounts assigned a password using the --account-password option or switch.
  - If the account is assigned a password using the set-account-password command.
  - If the account's password is reset to the initial password using the reset-account-password command
-e | enabled
- When used with the get-account command, filters results to enabled accounts.
- When used with the remove-account command, filters that enabled accounts only will be removed.
-d | disabled
- When used with the get-account command, filters results to disabled accounts.
- When used with the store-account command, specifies that the indicated account will be deactivated.
- When used with the remove-account command, filters that disabled accounts only will be removed.
- When used with the store-service command, specifies that the Identity Service will be deactivated.
-x | --excluded
- When used with the set-permission command, specifies that the permission will be denied. This applies to JOC Cockpit permissions and to all Controller permissions.
-q | --required
- When used with the store-service command, specifies that successful authentication using the Identity Service is required. If the switch is not used, then JOC Cockpit will switch to using the next Identity Service in case of unsuccessful authentication.
-r | --recursive
- When used with the set-folder and rename-folder commands, specifies that folder permissions are applied to sub-folders.
--single-factor-certificate
- When used with the store-service command, specifies that a certificate acts as a single factor for authentication.
--single-factor-password
- When used with the store-service command, specifies that a password acts as a single factor for authentication.
--show-logs
- Displays the log output created by the script if the --log-dir option is used.
--make-dirs
- If directories are missing that are indicated with the --log-dir option then they will be created.

Exit Codes

0: operation successful
1: argument errors
3: no objects found
4: JS7 REST Web Service is not reachable or reports errors

Examples

The following examples illustrate typical use cases.

Getting Identity Services

Code Block

language	bash
title	Examples for Getting Identity Services
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get list of Identity Services
./deploy-identity-service.sh get-service "${request_options[@]}"

# get Identity Service
./deploy-identity-service.sh get-service "${request_options[@]}" --service=JOC-INITIAL

Creating and Updating Identity Services

- service command, specifies single-factor or two-factor authentication using one of the values: SINGLE-FACTOR, TWO-FACTOR.
- Use of the option value TWO-FACTOR requires to specify the --second-service option.
--role
- Specifies the name of a role. for role-based or permission-based commands.
- If more than one role is specified, then they are separated by comma, for example: --role=administrator,business-user.
--new-role
- When used with the rename-role command, specifies the new name of the role.
--permission
- When used with the set-permission, rename-permission and remove-permission commands, specifies the permission identifiers to be used. For available permission identifiers see JS7 - Default Roles and Permissions.
- If more than one permission is used, then permission identifiers are separated by comma, for example: --permission='sos:products:controller:view','sos:products:controller:agents:view'.
--new-permission
- When used with the rename-permission command, specifies the new permission identifier.
--folder
- Specifies the folder to which permissions are applied and that limit user access to JOC Cockpit inventory folders.
- If more than one folder is used, then they are separated by comma, for example --folder=/accounting,/reporting.
--new-folder
- When used with the rename-folder command, specifies the new permission identifier.
--audit-message
- Specifies a message that is made available to the Audit Log.
- Specification of Audit Log messages can be enforced on a per user basis and for a JS7 environment.
--audit-time-spent
- Specifies the time spent to perform an operation which is added to the Audit Log.
- The option can be specified if the --audit-message option is used.
--audit-link
- Specifies a link (URL) which is added to the Audit Log.
- The option can be specified if the --audit-message option is used.
--log-dir
- If a log directory is specified then the script will log information about processing steps to a log file in this directory.
- File names are created according to the pattern: deploy-identity-service.<yyyy>-<MM>-<dd>T<hh>-<mm>-<ss>.log
- For example: deploy-identity-service.2024-10-19T20-50-45.log

Switches

-h | --help
- Displays usage.
-v | --verbose
- Displays verbose log output that includes requests and responses with the JS7 REST Web Service.
- When used twice as with -v -v then curl verbose output will be displayed.
-p | --password
- Asks the user for interactive keyboard input of the password used for the account specified with the --user option..
- The switch is used for secure interactive input as an alternative to use of the option --password=<password>.
-a | --account-password
- When used with the store-account and set-account-password commands, asks the user for interactive keyboard input of the existing password used for the account.
- The switch is used for secure interactive input as an alternative to use of the --account-password=<password> option.
-n | --new-password
- When used with the set-account-password command, asks the user for interactive keyboard input of the new password used for the account.
- The switch is used for secure interactive input as an alternative to use of the --new-account-password=<password> option.
-f | --force-password-change
- When used with the store-account command, specifies that the user will be challenged to type a new password on next login.
- The switch is used for existing accounts. Use of the switch is not required in the following situations that will automatically challenge the user to specify a new password on next login:
  - For new accounts using the initial password and for accounts assigned a password using the --account-password option or switch.
  - If the account is assigned a password using the set-account-password command.
  - If the account's password is reset to the initial password using the reset-account-password command
-e | --enabled
- When used with the get-account command, filters results to enabled accounts.
- When used with the remove-account command, limits the operation to enabled accounts.
-d | --disabled
- When used with the get-account command, filters results to disabled accounts.
- When used with the store-account command, specifies that the indicated account will be deactivated.
- When used with the remove-account command, limits the operation to disabled accounts.
- When used with the store-service command, specifies that the Identity Service will be deactivated.
-b | --blocked
- When used with the get-service command, returns the list of blocked accounts.
- The result list will be filtered if the --acount option is specified for an account.
-x | --excluded
- When used with the set-permission command, specifies that the permission will be denied. This applies to JOC Cockpit permissions and to permissions for all Controllers.
-q | --required
- When used with the store-service command, specifies that successful authentication using the Identity Service is required. If the switch is not used, then JOC Cockpit will switch to using the next Identity Service in case of unsuccessful authentication.
-r | --recursive
- When used with the set-folder and rename-folder commands, specifies that folder permissions are applied to sub-folders.
--show-logs
- Displays the log output created by the script if the --log-dir option is used.
--make-dirs
- If directories are missing that are indicated with the --log-dir option then they will be created.

Exit Codes

0: operation successful
1: argument errors
3: no objects found
4: JS7 REST Web Service is not reachable or reports errors

Examples

The following examples illustrate typical use cases.

Identity Services

Getting Identity Services

Code Block

language	bash
title	Examples for Getting

Code Block

language	bash
title	Examples for Creating and Updating Identity Services
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# storeget list of Identity ServiceServices
./deploy-identity-service.sh storeget-service "${request_options[@]}" --service=New-Service --service-type=OIDC

# 

# get Identity Service
./deploy-identity-service.sh get-service "${request_options[@]}" --service=JOC-INITIAL

Creating and Updating Identity Services

Code Block

language	bash
title	Examples for Creating and Updating Identity Services
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# store Identity Servicestore required Identity Service using password for single-factor authentication
./deploy-identity-service.sh store-service "${request_options[@]}" --service=New-Service --service-type=LDAP --required \
    OIDC

# store Identity Service using password for single-factor authentication
./deploy-identity-service.sh store-service "${request_options[@]}" --service=New-Service --service-type=LDAP \
                                           --authentication-scheme=SINGLE-FACTOR --

# store required Identity Service using two-factor authentication
./deploy-identity-service.sh store-service "${request_options[@]}" --service=FIDO-Service --service-type=FIDO
./deploy-identity-service.sh store-service "${request_options[@]}" --service=LDAP-Service --service-type=LDAP --required\
                                           --authentication-scheme=TWO-FACTOR

Renaming and Removing Identity Services

Code Block

language	bash
title	Examples for Renaming and Removing Identity Services
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# rename Identity Service
./deploy-identity-service.sh rename-service "${request_options[@]}" --service=Old-Service --new-service=New-Service

# remove Identity Service
./deploy-identity-service.sh remove-service "${request_options[@]}" --service=New-Service

Roles

Creating and Updating Roles

Code Block

language	bash
title	Examples for Creating and Updating Roles
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get list of roles
./deploy-identity-service.sh get-role   "${request_options[@]}" --service=JOC-INITIAL

# get role
./deploy-identity-service.sh get-role   "${request_options[@]}" --service=JOC-INITIAL --role=administrator

# store role
./deploy-identity-service.sh store-role "${request_options[@]}" --service=JOC-INITIAL --role=backoffice-user

Renaming and Removing Roles

Code Block

language	bash
title	Examples for Renaming and Removing Roles
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# rename role
./deploy-identity-service.sh rename-role "${request_options[@]}" --service=JOC-INITIAL --role=backoffice-user --new-role=business-user

# remove role
./deploy-identity-service.sh remove-role "${request_options[@]}" --service=JOC-INITIAL --role=business-user

# remove roles
./deploy-identity-service.sh remove-role "${request_options[@]}" --service=JOC-INITIAL --role=business-user,incident-manager

Permissions

Creating and Updating Permissions

Code Block

language	bash
title	Examples for Creating and Updating Permissions
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get permissions for role
./deploy-identity-service.sh get-permission "${request_options[@]}" --service=JOC-INITIAL --role=business-user

# assign permissions to role
./deploy-identity-service.sh set-permission "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                            --permission='sos:products:controller:view','sos:products:controller:agents:view'

Renaming and Removing Permissions

Code Block

language	bash
title	Examples for Renaming and Removing Permissions
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# rename permission
./deploy-identity-service.sh rename-permission "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                               --permission='sos:products:controller:deployment:manage' \
                                               --new-permission='sos:products:controller:deployment:view' --excluded

# remove permission
./deploy-identity-service.sh remove-permission "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                               --permission='sos:products:controller:deployment:view'

# remove permissions
./deploy-identity-service.sh remove-permission "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                               --permission='sos:products:controller:deployment','sos:products:controller:agents:view'

Folder Permissions

Creating and Updating Folder Permissions

Code Block

language	bash
title	Examples for Creating and Updating Folder Permissions
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get folder permissions for all folders assigned the indicated role
./deploy-identity-service.sh get-folder "${request_options[@]}" --service=JOC-INITIAL --role=business-user

# get folder permissions for the indicated role and folder
./deploy-identity-service.sh get-folder "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                        --folder=/accounting

# set folder permissions recursively for a number of folders
./deploy-identity-service.sh set-folder "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                        --folder=/accounting,/reporting --recursive

Renaming and Removing Folder Permissions

Code Block

language	bash
title	Examples for Renaming and Removing Folder Permissions
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# rename folder permissions
./deploy-identity-service.sh rename-folder "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                           --folder=/accounting --new-folder=/reporting --recursive

# remove folder permissions
./deploy-identity-service.sh remove-folder "${request_options[@]}" --service=JOC-INITIAL --role=business-user \
                                           --folder=/reporting

Accounts

Creating and Updating Accounts

Code Block

language	bash
title	Examples for Creating and Updating Accounts
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get list of accounts
./deploy-identity-service.sh get-account   "${request_options[@]}" --service=JOC-INITIAL

# get account
./deploy-identity-service.sh get-account   "${request_options[@]}" --service=JOC-INITIAL --account=test-account

# store account using initial password
./deploy-identity-service.sh store-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account

Setting Account Password

Code Block

language	bash
title	Examples for Setting Account Password
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# store account with specific password
./deploy-identity-service.sh store-account          "${request_options[@]}" --service=JOC-INITIAL --account=test-account \
                                                    --account-password=secret

# trigger password change for account on next login
./deploy-identity-service.sh store-account          "${request_options[@]}" --service=JOC-INITIAL --account=test-account \
                                                    --force-password-change

# set account password
./deploy-identity-service.sh set-account-password   "${request_options[@]}" --service=JOC-INITIAL --account=test-account \
                                                    --account-password=secret --new-password=very-secret

# reset account to use initial password
./deploy-identity-service.sh reset-account-password "${request_options[@]}" --service=JOC-INITIAL --account=test-account

Enabling and Disabling Accounts

Code Block

language	bash
title	Examples for Enabling and Disabling Accounts
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# enable account
./deploy-identity-service.sh enable-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account

# disable account
./deploy-identity-service.sh disable-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account

Blocking and Unblocking Accounts

Code Block

language	bash
title	Examples for Blocking and Unblocking Accounts
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# block account
./deploy-identity-service.sh block-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account

# get blocked account
./deploy-identity-service.sh get-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account --blocked

# unblock account
./deploy-identity-service.sh unblock-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account

# get list of blocked accounts
./deploy-identity-service.sh get-account "${request_options[@]}" --service=JOC-INITIAL --blocked

Renaming and Removing Accounts

Code Block

language	bash
title	Examples for Renaming and Removing Accounts
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# rename account
./deploy-identity-service.sh rename-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account --new-account=test-account2                   

# remove account
./deploy-identity-service.sh remove-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account2                                               -

# remove accounts
./deploy-identity-service.sh remove-account "${request_options[@]}"  --service=JOC-INITIAL --account=test-account1,test-account2

Setting up Identity Management

Setting up JOC Identity Service, Roles, Permissions and Accounts

The example is used to set up a JOC Identity Service from scratch:

The Identity Service is created
Roles for developers and operators are created.
Roles are assigned frequently used permissions. For permission identifiers see JS7 - Default Roles and Permissions.
Accounts are created that are assigned the initial password. On next login users are challenged to change password.

Code Block

language	bash
title	Examples for Setting up JOC Identity Service
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --folderpassword=/accountingroot)

# create setIdentity folderService permissionsusing recursivelypassword for a number of folderssingle-factor authentication
./deploy-identity-service.sh setstore-folderservice "${request_options[@]}" --service=JOCMy-INITIALService --service-roletype=business-userJOC \
                                           --authentication-scheme=SINGLE-FACTOR

# create roles
./deploy-identity-service.sh store-role          --folder=/accounting,/reporting --recursive

Renaming and Removing Folder Permissions

Code Block

language	bash
title	Examples for Renaming and Removing Folder Permissions
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# rename folder permissions"${request_options[@]}" --service=My-Service --role=developer
./deploy-identity-service.sh store-role     "${request_options[@]}" --service=My-Service --role=operator

# assign permissions to roles
./deploy-identity-service.sh renameset-folderpermission "${request_options[@]}" --service=JOCMy-INITIALService --role=businessdeveloper user \
                                           --folder=/accounting --new-folder=/reporting --recursive

# remove folder permissionspermission='sos:products:joc:administration:view','sos:products:joc:auditlog:view','sos:products:joc:calendars:view','sos:products:joc:cluster','sos:products:joc:inventory','sos:products:controller:view','sos:products:controller:agents:view'

./deploy-identity-service.sh removeset-folderpermission "${request_options[@]}" --service=JOCMy-INITIALService --role=businessoperator user \
                                           --folder=/reporting

Creating and Updating Accounts

Code Block

language	bash
title	Examples for Creating and Updating Accounts
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root)

# get list of accounts
./deploy-identity-service.sh get-account   "${request_options[@]}" --service=JOC-INITIAL

# get account            --permission='sos:products:joc:auditlog:view','sos:products:joc:calendars:view','sos:products:joc:cluster:view','sos:products:controller:view','sos:products:controller:agents:view'

# create accounts and assign roles 
./deploy-identity-service.sh getstore-account   "${request_options[@]}" --service=JOCMy-INITIALService --account=test-account

# store account using initial password
dev --role=developer
./deploy-identity-service.sh store-account  "${request_options[@]}" --service=JOC-INITIAL --account=test-account

...

My-Service --account=ops --role=operator

Setting up LDAP Identity Service, Roles, Permissions and Accounts

The example is used to set up an Identity Service from scratch:

The Identity Service is created. For use with Identity Services such as LDAP, OIDC, FIDO the related service settings have to be provided from .json files. Such files can be created by reading Identity Service settings.
Code Block
language

...

yml
title

...

Example for LDAP settings in JSON Format
linenumbers true

...


collapse	true

{
  "simple": {
    "iamLdapHost": "openldap-2-4",
    "iamLdapHostNameVerification": null,
    "iamLdapPort": 636,
    "iamLdapProtocol": "SSL"
  },
  "expert": {
    "iamLdapGroupNameAttribute": "cn",
    "iamLdapGroupRolesMap": {
      "items": [
        {

...

"ldapGroupDn": "js7dev",

...

"roles": [ "

...

developer"
          ]
        },
        {
          "ldapGroupDn": "js7ops",
          "roles": [

...

"

...

operator"
          ]
        }
      ]
    },
    "iamLdapGroupSearchBase": "dc=sos-berlin,dc=com",
    "iamLdapGroupSearchFilter": "(memberUid=%s)",
    "iamLdapSearchBase": "",
    "iamLdapServerUrl": "ldaps://openldap-2-4:636",
    "iamLdapUseStartTls": false,

...

"iamLdapUserDnTemplate": "uid={0},ou=users,ou=sales,o=sos,dc=sos-berlin,dc=com",
    "iamLdapUserNameAttribute": "",
    "iamLdapUserSearchFilter": ""
  }
}

Roles for developers and operators are created.
Roles are assigned frequently used permissions. For permission identifiers see JS7 - Default Roles and Permissions.
Accounts are created that are assigned the initial password. On next login users are challenged to change password.

Code Block

language	bash
title	Examples for Enabling and Disabling AccountsExample for Setting up LDAP Identity Service
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# enable account
./deploy-identity-service.sh enable-account "${request_options[@]}" --service=JOC-INITIAL --account=test-account

# disable accountcreate Identity Service using password for single-factor authentication
./deploy-identity-service.sh disablestore-accountservice "${request_options[@]}" --service=JOC-INITIAL --account=test-account

Renaming and Removing Accounts

Code Block

language	bash
title	Examples for Renaming and Removing Accounts
linenumbers	true

# common options for connection to JS7 REST API
request_options=(--url=http://localhost:4446 --user=root --password=root) 

# rename permission
My-Service --service-type=LDAP \
                                           --authentication-scheme=SINGLE-FACTOR

# get settings from an existing Identity Service
#     store settings to an environment variable
# settings=$(./deploy-identity-service.sh renameget-service-permissionsettings "${request_options[@]}" --service=JOCMy-INITIALService --role=business-user \
                              service-type=LDAP)
#     store settings to a file
# ./deploy-identity-service.sh get-service-settings "${request_options[@]}"     --permission='sos:products:controller:deployment:manage' \
--service=My-Service --service-type=LDAP > ./examples/ldap-settings.json
#     read settings from a file
# settings=$(cat ./examples/ldap-settings.json)
 
# store                 Identity Service settings
./deploy-identity-service.sh store-service-settings "${request_options[@]}" --service=My-Service --service-type=LDAP --settings="$settings"

# create roles
./deploy-identity-service.sh store-role     "${request_options[@]}" --service=My-Service --role=developer
./deploy-identity-service.sh store-role         --new-permission='sos:products:controller:deployment:view' --excluded"${request_options[@]}" --service=My-Service --role=operator

# remove permissionassign permissions to roles
./deploy-identity-service.sh removeset-permission "${request_options[@]}" --service=JOCMy-INITIALService --role=business-userdeveloper \
                                                                  --permission=--permission='sos:products:joc:administration:view','sos:products:joc:auditlog:view','sos:products:joc:calendars:view','sos:products:joc:cluster','sos:products:joc:inventory','sos:products:controller:view','sos:products:controller:deploymentagents:view'

# remove permissions
./deploy-identity-service.sh removeset-permission "${request_options[@]}" --service=JOCMy-INITIALService --role=business-useroperator \
                                               --permission='sos:products:joc:auditlog:controller:deploymentview','sos:products:joc:calendars:view','sos:products:joc:cluster:view','sos:products:controller:view','sos:products:controller:agents:view'

...

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 13

New Version Current

Key

Identity Service Deployment Script

Roles

Roles

Folder Permissions

Options

Options

Switches

Exit Codes

Examples

Getting Identity Services

Creating and Updating Identity Services

Switches

Exit Codes

Examples

Identity Services

Getting Identity Services

Creating and Updating Identity Services

Renaming and Removing Identity Services

Roles

Creating and Updating Roles

Renaming and Removing Roles

Permissions

Creating and Updating Permissions

Renaming and Removing Permissions

Folder Permissions

Creating and Updating Folder Permissions

Renaming and Removing Folder Permissions

Accounts

Creating and Updating Accounts

Setting Account Password

Enabling and Disabling Accounts

Blocking and Unblocking Accounts

Renaming and Removing Accounts

Setting up Identity Management

Setting up JOC Identity Service, Roles, Permissions and Accounts

Renaming and Removing Folder Permissions

Creating and Updating Accounts

Setting up LDAP Identity Service, Roles, Permissions and Accounts

Renaming and Removing Accounts