Among the commands that operate user information, the following three types of commands use XML:
fscsm_user create (Addition of user information)
fscsm_user modify (Modification of user information)
fscsm_user export (Export of user information)
fscsm_user import (Batch addition, modification, and check of batch addition information of user information)
The format of the XML file corresponding to the command above is explained below.
The elements of the XML must be specified using the following hierarchical structure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<users>
<user>
<userId>User ID</userId>
<orgId>Organization ID</orgId>
<password>Password</password>
<userName>User Name</userName>
<roleIds>
<roleId>operation_manager</roleId>
<roleId>bizSysProv_manager</roleId>
</roleIds>
<mailAddress>Email Address</mailAddress>
<phoneNumber>Contact Information</phoneNumber>
<comment>User Comment</comment>
<customFields>
<customField no="1">User Custom Field 1</customField>
<customField no="2">User Custom Field 2</customField>
<customField no="3">User Custom Field 3</customField>
<customField no="4">User Custom Field 4</customField>
<customField no="5">User Custom Field 5</customField>
</customFields>
</user>
</users> |
Element (Element Name or Element Name and Attribute) | Required or Displayed | Specifiable Values During Addition or Modification | |||
|---|---|---|---|---|---|
Addition | Modification | Output | |||
User ID | Yes | Yes *1 | Yes | Specify a character string containing 1 to 320 alphanumeric characters, underscores ("_"), hyphens ("-"), periods ("."), and at marks ("@"). This field is case insensitive, so user IDs that only differ by the cases of the characters used will be recognized as the same user ID. For example, if "User" has been registered, then "user" cannot be registered. The ID must not overlap with the IDs of other users. Specify a unique value. When configuring the fscsm_config configuration file such that Active Directory coordination is used, it is necessary to register the same user in Active Directory. For the user ID, specify the login name used in the coordinating SVOM. | |
Organization ID | Yes | Yes | Yes | Specify the organization ID of the organization to which the user to be created belongs. Specify an organization ID by outputting the organization ID using "5.2.1 Organization Operation Commands". When adding users belonging to operators or planners, specify "!mgr". | |
Password | Yes | No | - | Specify a character string containing 8 to 64 alphanumeric characters, \"=|[]:*;+,<>?/ and ASCII characters excluding blank spaces and control characters. If this item is omitted during modification, the password is not modified. When user information is output using "5.2.2 User Operation Commands", this element is not output. When configuring the settings that use Active Directory coordination in the fscsm_config.xml configuration file, this specification is invalid. Even if a password is specified during creation or modification, the password which was configured in advance is used. | |
User Name | Yes | Yes | Yes | Specify a character string containing 1 to 64 characters. | |
Role | Yes | Yes | Yes | Specify one of the following: | |
Value | Description | ||||
planEval_manager | Planners - Approver | ||||
planEval_user | Planners - Representative | ||||
operation_manager | Operators - Approver | ||||
operation_user | Operators - Representative | ||||
operation_admin | Operators - Administrator | ||||
bizSysProv_manager | Platform Providers - Approver | ||||
bizSysProv_user | Platform Providers - Representative | ||||
Configuring multiple roleId elements enables dual roles. The combinations which can be configured are as described below. | |||||
Value ("+" indicates a dual role. When specifying XML, individually configure each value for the roleId element.) | Description | ||||
planEval_manager + bizSysProv_manager | Planners - Approver and Platform Providers - Approver | ||||
planEval_user + bizSysProv_user | Planners - Representative and Platform Providers - Representative | ||||
operation_manager + bizSysProv_manager | Operators - Approver and Platform Providers - Approver | ||||
operation_user + bizSysProv_user | Operators - Representative and Platform Providers - Representative | ||||
operation_manager + operation_admin | Operators - Approver and Administrator | ||||
operation_user + operation_admin | Operators - Representative and Administrator | ||||
operation_manager + bizSysProv_manager + operation_admin | Operators - Approver and Platform Providers - Approver and Operators - Administrator | ||||
operation_user + bizSysProv_user + operation_admin | Operators - Representative and Platform Providers - Representative and Administrator | ||||
The roles available during modification depend on the role before switching. Refer to "Table 5.3 Correspondence Table for Role Modification". | |||||
Email Address | Yes | Yes | Yes | Specify an email address to which notification about requests are sent. Specify a character string which contains 1 to 256 characters and qualifies as a "/^[\w\.\-]+@(?:[\w\-]+\.)+[\w\-]+$/" regular expression. If X is defined as a string which contains alphanumeric characters, hyphens (-), and underscores (_), and Y contains X and periods (.), the format of the regular expression is "Y@X.X". | |
Contact Information | Yes | Yes | Yes | Specify a phone number as contact information. Specify a character string containing 1 to 256 characters. | |
User Comment | No | No | Yes | Specify a user comment. Specify a character string containing 0 to 256 characters. | |
User Custom Field N | No | No | Yes | Specify a character string for the custom field. Only the specification of custom fields to be created or modified is permitted. Specify a character string containing 0 to 256 characters. When specifying values for custom fields, be sure to specify a number for N. The number cannot be omitted and as many as 5 different numbers can be specified. The content of each user custom field is defined using gui.user.customfield.label.<n>, which is defined in the system information definition file. Specify the value for N according to the content of this definition. | |
The meanings of the entries listed under "Required or Displayed" are as follows:
Yes: Entry is required, or element is output.
No: Can be omitted.
-: Specification is not permitted, or element is not output.
*1: Modification is not possible.
Role Identifier | Role before Modification ("+" Indicates a Dual Role) | Role before Modification | Specifiable Roles (Roles are Indicated Using Role Identifiers. When Specifying an XML File, Configure a Role Type for Each roleId Element.) |
|---|---|---|---|
A | planEval_manager | Planners - Approver | B |
B | planEval_user | Planners - Representative | A |
C | operation_manager | Operators - Approver | D, G, C+G, D+G |
D | operation_user | Operators - Representative | C, G, C+G, D+G |
E | bizSysProv_manager | Platform Providers - Approver | F, A+E, B+F, C+E, D+F, C+E+G, D+F+G |
F | bizSysProv_user | Platform Providers - Representative | E, A+E, B+F, C+E, D+F, C+E+G, D+F+G |
G | operation_admin | Operators - Administrator | C, D, C+G, D+G |
A+E | planEval_manager + bizSysProv_manager | Planners - Approver and | E, F, B+F, C+E, D+F, C+E+G, D+F+G |
B+F | planEval_user + bizSysProv_user | Planners - Representative and | E, F, A+E C+E, D+F, C+E+G, D+F+G |
C+E | operation_manager + bizSysProv_manager | Operators - Approver and Platform Providers - Approver | E, F, A+E, B+F, D+F, C+E+G, D+F+G |
D+F | operation_user + bizSysProv_user | Operators - Representative and Platform Providers - Representative | E, F, A+E, B+F, C+E, C+E+G, D+F+G |
C+G | operation_manager + operation_admin | Operators - Approver and Administrator | C, D, G, D+G |
D+G | operation_user + operation_admin | Operators - Representative and Administrator | C, D, G, C+G |
C+E+G | operation_manager + bizSysProv_manager + operation_admin | Operators - Approver, Platform Providers - Approver and Administrator | E, F, A+E, B+F, C+E, D+F, D+F+G |
D+F+G | operation_user + bizSysProv_user + operation_admin | Operators - Representative and Platform Providers - Representative and Administrator | E, F, A+E, B+F, C+E, D+F, C+E+G |
