Add Account

Add a new Managed Account to an organization. The email used to create the account must be from a verified domain.

Method

POST

URL

/Users

Request example

Request body

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    	"userName": "example@nulab.com",
    	"active": true,
    	"displayName": "Example Nulab",
        "preferredLanguage": "en",
	    "locale": "en",
	    "timezone": "Asia/Tokyo",
  	    "roles" : [ {
    		"value" : "USER",
    		"primary" : true
            }
        ],
    "meta": {
        "resourceType": "User"
    }
}

Request description

Parameter name	Type	Description
schemas (required)	String	Fixed as request example
userName (required)	String	Verified domain email address (uniquely identifies the account)
displayName (required)	String	Username
preferredLanguage	String	Language If preferredLanguage and locale are not specified, the token issuer’s language will be registered for the Managed Account.
locale	String	Language (preferredLanguage takes precedence)
timezone	String	Time zone If not specified, the token issuer’s time zone will be registered for the Managed Account.
active	Boolean	Status of the account (true = active, false = inactive). Only true can be specified for new accounts.
roles.[0].value	String	ADMIN = Administrator USER = Member GUEST = Guest If not specified, it will be GUEST. If more than one is specified, the value of the role whose primary is true is registered.
meta (required)
resourceType (required)	String	Fixed as “User”

Values other than those listed above are ignored during registration.

Response example

Status line / Response header

HTTP/1.1	201 Created
Content-Type: application/json;charset=UTF-8

Response body

{
    "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu",
    "meta":{
        "resourceType": "User",
        "created": "2024-03-22T04:42:01Z",
        "lastModified": "2024-03-22T04:42:01Z",
        "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu"
    },
    "userName": "example@nulab.com",
    "displayName": "Example Nulab",
    "preferredLanguage": "en",
    "locale": "en",
    "timezone": "Asia/Tokyo",
    "active": true,
    "roles":[
        {
            "value": "USER",
            "primary": true
        }
    ]
}

Response description

Parameter name	Type	Description
id	String	Account ID (string that uniquely identifies the account)
userName	String	Email address (uniquely identifies the account)
displayName	String	Username
preferredLanguage	String	Language (same value as locale)
locale	String	Language (same value as preferredLanguage)
timezone	String	Time zone
active	Boolean	Status of the account (true = active, false = inactive)
roles.[0].value	String	ADMIN = Administrator USER = Member GUEST = Guest