Skip to main content
POST
/
ims
/
oneroster
/
rostering
/
v1p2
/
users
Create a new User
curl --request POST \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": {
    "enabledUser": true,
    "givenName": "<string>",
    "familyName": "<string>",
    "roles": [
      {
        "roleType": "primary",
        "role": "administrator",
        "org": {
          "sourcedId": "<string>"
        },
        "userProfile": "<string>",
        "metadata": {
          "timebackRole": "head_of_school",
          "alphaLevelAccess": [
            "<string>"
          ]
        },
        "beginDate": "<string>",
        "endDate": "<string>"
      }
    ],
    "email": "[email protected]",
    "sourcedId": "<string>",
    "metadata": {
      "onboarding": {},
      "isTestUser": true
    },
    "status": "active",
    "userMasterIdentifier": "<string>",
    "username": "<string>",
    "userIds": [
      {
        "type": "<string>",
        "identifier": "<string>"
      }
    ],
    "middleName": "<string>",
    "primaryOrg": {
      "sourcedId": "<string>"
    },
    "preferredFirstName": "<string>",
    "preferredMiddleName": "<string>",
    "preferredLastName": "<string>",
    "pronouns": "<string>",
    "grades": [
      "-1"
    ],
    "password": "<string>",
    "sms": "<string>",
    "phone": "<string>",
    "agents": []
  }
}
'
{
  "sourcedIdPairs": {
    "suppliedSourcedId": "<string>",
    "allocatedSourcedId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
user
object
required

Response

User successfully created

sourcedIdPairs
object
required