Among the commands that operate user information, the following three types of commands use XML:
fscsm_user create (user information registration)
fscsm_user modify (user information modification)
fscsm_user export (user information output)
The formats of the XML files corresponding to each of these commands are explained below.
Elements of XML must be as the following stratum structure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <users> <user> <userId>User ID</userId> <orgRId>Resource ID of the Organization</orgRId> <password>Password</password> <userName>User Name</userName> <roleId>Role</roleId> <mailAddress>Mail Address</mailAddress> <phoneNumber>Contact Information</phoneNumber> <comment>Description</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 (Name or Attribute) | Omission or Display | Acceptable Value in Registration or Modification | |||||
Registration | Modification | Output | |||||
User ID (userId) | ○ | ○ *1 | ○ | Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The ID must not overlap other user ID. Specify a unique value. | |||
Resource ID of the Organization (orgRId) | ○ | ○ | ○ | Specify the resource ID of the organization where the user belongs. Specify an integer number within 8-digit. Use organization operation commands to get the existing parent organization. Specify 1, in the case of registering users belonging to operators or planners. Role (roleId) and the resource ID of the organization (orgRId) cannot be modified at the same time. | |||
Password (password) | ○ | △ | × | Specify a character string containing 8 to 64 alphanumeric characters, \"=|[]:*;+,<>?/ and ASCII characters excluding blank spaces and control characters. Password is not modified if specifying password is omitted. | |||
User Name (userName) | ○ | ○ | ○ | Specify a character string containing 1 to 64 characters. | |||
Role (roleId) | ○ | ○ | ○ | Specify one of the followings. | |||
Value | Description | ||||||
planEval_manager | Planners - Approver | ||||||
planEval_user | Planners - Representative | ||||||
operation_manager | Operators - Approver | ||||||
operation_user | Operators - Representative | ||||||
bizSysProv_manager | Platform Providers - Approver | ||||||
bizSysProv_user | Platform Providers - Representative | ||||||
Available role depends on the current role and its attribute of organization where the user belongs. | |||||||
Current Role | Organization Attribute | Available Role | |||||
planEval_manager/ planEval_user | - | planEval_manager/ planEval_user | |||||
operation_manager/ operation_user | - | operation_manager/ operation_user | |||||
bizSysProv_manager | node | bizSysProv_manager | |||||
bizSysProv_manager/ bizSysProv_user | leaf | bizSysProv_manager/ bizSysProv_user | |||||
And role (roleId) and resource ID of the organization (orgRId) cannot be modified at the same time. | |||||||
Mail Address (mailAddress) | ○ | ○ | ○ | Specify e-mail address which notification about requests are sent to. Specify a character string implemented the regular expression, which is /^[\w\.\-]+@(?:[\w\-]+\.)+[\w\-]+$/. Format of the regular expression is "Y@X.X". X: a character string which consists of alphanumeric characters, underscores ("_") and hyphens ("-"). | |||
Contact information (phoneNumber) | ○ | ○ | ○ | Specify a character string containing 1 to 256 characters as the contact phone number. | |||
Description (comment) | △ | △ | ○ | Specify a character string containing 0 to 256 characters. | |||
User Custom Field N (customField no="N") | △ | △ | ○ | Specify a character string containing 0 to 256 characters as a value of the custom field. Specifying only custom fields to be made or modified is permitted. Specify sequential number in the Ns if custom fields are specified. The Ns are not permitted to omit and can be specified by five numbers. On the cloud management portal, custom fields are displayed by number of gui.user.customfield.label.<n> specified in the system information. | |||
Refer to the following about symbols of the "Omission or Display" column.
○: Entry is mandatory, or element is output.
△: Omission is permitted.
×: Specifying is not permitted, or element is not output.
*1: Modifying is not permitted.