AddUser

Create a new user for the group

Description

Creates a new user in the specified group

Method

POST

Request URL Format

/api/v0/users

Payload

Content-Type : application/json

Parameter Name	Description	Data Type	Required	Remarks
email	Email address to be added to the group	String	Required
g_id	ID to identify the group to which the user is to be added	String	Required
username	User name to be added to the group	String
send_password_to_email	Send registration completion email when API is executed	boolean		Default false
sender_address	Arbitrary email address to be specified in the registration completion email from	String
no_confirm_email	Optional; if true, no confirmation mail is sent and the initial password (tmp_password) specified by the administrator is set.	boolean
tmp_password	If no_confirm_email:true, specify the initial password by administrator	String
invitor_id	If no_confirm_email:true, specifies the user ID from which the invitation originated	String		Use the password policy of the workspace to which this user belongs
conf_email_template_id	Template ID for email notification	String
confirm_email_ack	Flag to be notified via email	boolean		true -> enabled, false -> disabled
exclusive_w_id	When adding as a workspace-only user, specify the target workspace ID.	String
user_code	Specify a user code to share a single email address with multiple users	String

Payload Example

{
  "email": "[email protected]",
  "g_id": "Grp-pgI1GFDL"
  "username": "Hexa_Taro",
  "send_password_to_email": true,
  "sender_address": "[email protected]"
  "no_confirm_email": true,
  "tmp_password": "123456",
  "invitor_id": "5af30766baa8df0007918ed8",
  "conf_email_template_id": string,
  "confirm_email_ack": true,
  "exclusive_w_id": "63c00e67be62647c659f8b4b",
  "user_code": "UserCode12345"
}

Request URL Example

POST https://api.xxx.com/api/v0/users

Response Example

{
    "added": false, //("bool added or not")
    "exists": false, //("bool already an existing user false=New, nonexistent new user")
    "user_profile": { //("User profile object")
        "confirmed": false,　//("bool user email confirmed false=not confirmed on email")
        "email": "登録されたユーザーのemail", 
        "email_sent": false, //("bool email has been sent. false=email has already been sent to the target email")
        "profile_pics": [//("User Profile Image Objects")
            {
                "mediaLink": "https://storage.googleapis.com/linker/pub/default.png"　//("Location of images used in user profiles")
            }
        ],
        "u_id": "登録されたユーザーのID",
        "username": "登録されたユーザー名"
    }
}