Update an existing User
curl --request PUT \
--url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": {
"metadata": {
"onboarding": {},
"isTestUser": true,
"skipRosterImport": true
},
"identifier": "<string>",
"userMasterIdentifier": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"grades": [],
"sms": "<string>",
"phone": "<string>",
"agents": [],
"roles": [
{
"org": {
"sourcedId": "<string>"
},
"userProfile": "<string>",
"metadata": {
"alphaLevelAccess": [
"<string>"
]
},
"beginDate": "<string>",
"endDate": "<string>"
}
],
"demographics": {
"birthDate": "<string>",
"americanIndianOrAlaskaNative": "<string>",
"asian": "<string>",
"blackOrAfricanAmerican": "<string>",
"nativeHawaiianOrOtherPacificIslander": "<string>",
"white": "<string>",
"demographicRaceTwoOrMoreRaces": "<string>",
"hispanicOrLatinoEthnicity": "<string>",
"countryOfBirthCode": "<string>",
"stateOfBirthAbbreviation": "<string>",
"cityOfBirth": "<string>",
"publicSchoolResidenceStatus": "<string>"
},
"enabledUser": true
},
"expectedDateLastModified": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}"
payload = {
"user": {
"metadata": {
"onboarding": {},
"isTestUser": True,
"skipRosterImport": True
},
"identifier": "<string>",
"userMasterIdentifier": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"grades": [],
"sms": "<string>",
"phone": "<string>",
"agents": [],
"roles": [
{
"org": { "sourcedId": "<string>" },
"userProfile": "<string>",
"metadata": { "alphaLevelAccess": ["<string>"] },
"beginDate": "<string>",
"endDate": "<string>"
}
],
"demographics": {
"birthDate": "<string>",
"americanIndianOrAlaskaNative": "<string>",
"asian": "<string>",
"blackOrAfricanAmerican": "<string>",
"nativeHawaiianOrOtherPacificIslander": "<string>",
"white": "<string>",
"demographicRaceTwoOrMoreRaces": "<string>",
"hispanicOrLatinoEthnicity": "<string>",
"countryOfBirthCode": "<string>",
"stateOfBirthAbbreviation": "<string>",
"cityOfBirth": "<string>",
"publicSchoolResidenceStatus": "<string>"
},
"enabledUser": True
},
"expectedDateLastModified": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user: {
metadata: {onboarding: {}, isTestUser: true, skipRosterImport: true},
identifier: '<string>',
userMasterIdentifier: '<string>',
username: '<string>',
givenName: '<string>',
familyName: '<string>',
middleName: '<string>',
email: 'jsmith@example.com',
preferredFirstName: '<string>',
preferredMiddleName: '<string>',
preferredLastName: '<string>',
pronouns: '<string>',
grades: [],
sms: '<string>',
phone: '<string>',
agents: [],
roles: [
{
org: {sourcedId: '<string>'},
userProfile: '<string>',
metadata: {alphaLevelAccess: ['<string>']},
beginDate: '<string>',
endDate: '<string>'
}
],
demographics: {
birthDate: '<string>',
americanIndianOrAlaskaNative: '<string>',
asian: '<string>',
blackOrAfricanAmerican: '<string>',
nativeHawaiianOrOtherPacificIslander: '<string>',
white: '<string>',
demographicRaceTwoOrMoreRaces: '<string>',
hispanicOrLatinoEthnicity: '<string>',
countryOfBirthCode: '<string>',
stateOfBirthAbbreviation: '<string>',
cityOfBirth: '<string>',
publicSchoolResidenceStatus: '<string>'
},
enabledUser: true
},
expectedDateLastModified: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'user' => [
'metadata' => [
'onboarding' => [
],
'isTestUser' => true,
'skipRosterImport' => true
],
'identifier' => '<string>',
'userMasterIdentifier' => '<string>',
'username' => '<string>',
'givenName' => '<string>',
'familyName' => '<string>',
'middleName' => '<string>',
'email' => 'jsmith@example.com',
'preferredFirstName' => '<string>',
'preferredMiddleName' => '<string>',
'preferredLastName' => '<string>',
'pronouns' => '<string>',
'grades' => [
],
'sms' => '<string>',
'phone' => '<string>',
'agents' => [
],
'roles' => [
[
'org' => [
'sourcedId' => '<string>'
],
'userProfile' => '<string>',
'metadata' => [
'alphaLevelAccess' => [
'<string>'
]
],
'beginDate' => '<string>',
'endDate' => '<string>'
]
],
'demographics' => [
'birthDate' => '<string>',
'americanIndianOrAlaskaNative' => '<string>',
'asian' => '<string>',
'blackOrAfricanAmerican' => '<string>',
'nativeHawaiianOrOtherPacificIslander' => '<string>',
'white' => '<string>',
'demographicRaceTwoOrMoreRaces' => '<string>',
'hispanicOrLatinoEthnicity' => '<string>',
'countryOfBirthCode' => '<string>',
'stateOfBirthAbbreviation' => '<string>',
'cityOfBirth' => '<string>',
'publicSchoolResidenceStatus' => '<string>'
],
'enabledUser' => true
],
'expectedDateLastModified' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}"
payload := strings.NewReader("{\n \"user\": {\n \"metadata\": {\n \"onboarding\": {},\n \"isTestUser\": true,\n \"skipRosterImport\": true\n },\n \"identifier\": \"<string>\",\n \"userMasterIdentifier\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"grades\": [],\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"agents\": [],\n \"roles\": [\n {\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"userProfile\": \"<string>\",\n \"metadata\": {\n \"alphaLevelAccess\": [\n \"<string>\"\n ]\n },\n \"beginDate\": \"<string>\",\n \"endDate\": \"<string>\"\n }\n ],\n \"demographics\": {\n \"birthDate\": \"<string>\",\n \"americanIndianOrAlaskaNative\": \"<string>\",\n \"asian\": \"<string>\",\n \"blackOrAfricanAmerican\": \"<string>\",\n \"nativeHawaiianOrOtherPacificIslander\": \"<string>\",\n \"white\": \"<string>\",\n \"demographicRaceTwoOrMoreRaces\": \"<string>\",\n \"hispanicOrLatinoEthnicity\": \"<string>\",\n \"countryOfBirthCode\": \"<string>\",\n \"stateOfBirthAbbreviation\": \"<string>\",\n \"cityOfBirth\": \"<string>\",\n \"publicSchoolResidenceStatus\": \"<string>\"\n },\n \"enabledUser\": true\n },\n \"expectedDateLastModified\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": {\n \"metadata\": {\n \"onboarding\": {},\n \"isTestUser\": true,\n \"skipRosterImport\": true\n },\n \"identifier\": \"<string>\",\n \"userMasterIdentifier\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"grades\": [],\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"agents\": [],\n \"roles\": [\n {\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"userProfile\": \"<string>\",\n \"metadata\": {\n \"alphaLevelAccess\": [\n \"<string>\"\n ]\n },\n \"beginDate\": \"<string>\",\n \"endDate\": \"<string>\"\n }\n ],\n \"demographics\": {\n \"birthDate\": \"<string>\",\n \"americanIndianOrAlaskaNative\": \"<string>\",\n \"asian\": \"<string>\",\n \"blackOrAfricanAmerican\": \"<string>\",\n \"nativeHawaiianOrOtherPacificIslander\": \"<string>\",\n \"white\": \"<string>\",\n \"demographicRaceTwoOrMoreRaces\": \"<string>\",\n \"hispanicOrLatinoEthnicity\": \"<string>\",\n \"countryOfBirthCode\": \"<string>\",\n \"stateOfBirthAbbreviation\": \"<string>\",\n \"cityOfBirth\": \"<string>\",\n \"publicSchoolResidenceStatus\": \"<string>\"\n },\n \"enabledUser\": true\n },\n \"expectedDateLastModified\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": {\n \"metadata\": {\n \"onboarding\": {},\n \"isTestUser\": true,\n \"skipRosterImport\": true\n },\n \"identifier\": \"<string>\",\n \"userMasterIdentifier\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"grades\": [],\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"agents\": [],\n \"roles\": [\n {\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"userProfile\": \"<string>\",\n \"metadata\": {\n \"alphaLevelAccess\": [\n \"<string>\"\n ]\n },\n \"beginDate\": \"<string>\",\n \"endDate\": \"<string>\"\n }\n ],\n \"demographics\": {\n \"birthDate\": \"<string>\",\n \"americanIndianOrAlaskaNative\": \"<string>\",\n \"asian\": \"<string>\",\n \"blackOrAfricanAmerican\": \"<string>\",\n \"nativeHawaiianOrOtherPacificIslander\": \"<string>\",\n \"white\": \"<string>\",\n \"demographicRaceTwoOrMoreRaces\": \"<string>\",\n \"hispanicOrLatinoEthnicity\": \"<string>\",\n \"countryOfBirthCode\": \"<string>\",\n \"stateOfBirthAbbreviation\": \"<string>\",\n \"cityOfBirth\": \"<string>\",\n \"publicSchoolResidenceStatus\": \"<string>\"\n },\n \"enabledUser\": true\n },\n \"expectedDateLastModified\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"user": {
"sourcedId": "<string>",
"status": "active",
"enabledUser": "true",
"givenName": "<string>",
"familyName": "<string>",
"roles": [],
"agents": [],
"userProfiles": [],
"email": "jsmith@example.com",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"userMasterIdentifier": "<string>",
"username": "<string>",
"userIds": [
{
"type": "<string>",
"identifier": "<string>"
}
],
"middleName": "<string>",
"primaryOrg": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"identifier": "<string>",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"grades": [
"3"
],
"password": "<string>",
"sms": "<string>",
"phone": "<string>",
"demographics": {
"sourcedId": "<string>",
"status": "active",
"birthDate": "<string>",
"sex": "male",
"americanIndianOrAlaskaNative": "<string>",
"asian": "<string>",
"blackOrAfricanAmerican": "<string>",
"nativeHawaiianOrOtherPacificIslander": "<string>",
"white": "<string>",
"demographicRaceTwoOrMoreRaces": "<string>",
"hispanicOrLatinoEthnicity": "<string>",
"countryOfBirthCode": "<string>",
"stateOfBirthAbbreviation": "<string>",
"cityOfBirth": "<string>",
"publicSchoolResidenceStatus": "<string>",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {}
}
}
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "invaliddata"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "unauthorisedrequest"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "forbidden"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "unknownobject"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "invaliddata"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "invaliddata"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "server_busy"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "internal_server_error"
}
]
},
"imsx_error_details": [
{}
]
}Users Management
Update an existing User
To update an existing User on the service provider. The sourcedId for the record to be updated is supplied by the requesting system.
PUT
/
ims
/
oneroster
/
rostering
/
v1p2
/
users
/
{sourcedId}
Update an existing User
curl --request PUT \
--url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": {
"metadata": {
"onboarding": {},
"isTestUser": true,
"skipRosterImport": true
},
"identifier": "<string>",
"userMasterIdentifier": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"grades": [],
"sms": "<string>",
"phone": "<string>",
"agents": [],
"roles": [
{
"org": {
"sourcedId": "<string>"
},
"userProfile": "<string>",
"metadata": {
"alphaLevelAccess": [
"<string>"
]
},
"beginDate": "<string>",
"endDate": "<string>"
}
],
"demographics": {
"birthDate": "<string>",
"americanIndianOrAlaskaNative": "<string>",
"asian": "<string>",
"blackOrAfricanAmerican": "<string>",
"nativeHawaiianOrOtherPacificIslander": "<string>",
"white": "<string>",
"demographicRaceTwoOrMoreRaces": "<string>",
"hispanicOrLatinoEthnicity": "<string>",
"countryOfBirthCode": "<string>",
"stateOfBirthAbbreviation": "<string>",
"cityOfBirth": "<string>",
"publicSchoolResidenceStatus": "<string>"
},
"enabledUser": true
},
"expectedDateLastModified": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}"
payload = {
"user": {
"metadata": {
"onboarding": {},
"isTestUser": True,
"skipRosterImport": True
},
"identifier": "<string>",
"userMasterIdentifier": "<string>",
"username": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"middleName": "<string>",
"email": "jsmith@example.com",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"grades": [],
"sms": "<string>",
"phone": "<string>",
"agents": [],
"roles": [
{
"org": { "sourcedId": "<string>" },
"userProfile": "<string>",
"metadata": { "alphaLevelAccess": ["<string>"] },
"beginDate": "<string>",
"endDate": "<string>"
}
],
"demographics": {
"birthDate": "<string>",
"americanIndianOrAlaskaNative": "<string>",
"asian": "<string>",
"blackOrAfricanAmerican": "<string>",
"nativeHawaiianOrOtherPacificIslander": "<string>",
"white": "<string>",
"demographicRaceTwoOrMoreRaces": "<string>",
"hispanicOrLatinoEthnicity": "<string>",
"countryOfBirthCode": "<string>",
"stateOfBirthAbbreviation": "<string>",
"cityOfBirth": "<string>",
"publicSchoolResidenceStatus": "<string>"
},
"enabledUser": True
},
"expectedDateLastModified": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user: {
metadata: {onboarding: {}, isTestUser: true, skipRosterImport: true},
identifier: '<string>',
userMasterIdentifier: '<string>',
username: '<string>',
givenName: '<string>',
familyName: '<string>',
middleName: '<string>',
email: 'jsmith@example.com',
preferredFirstName: '<string>',
preferredMiddleName: '<string>',
preferredLastName: '<string>',
pronouns: '<string>',
grades: [],
sms: '<string>',
phone: '<string>',
agents: [],
roles: [
{
org: {sourcedId: '<string>'},
userProfile: '<string>',
metadata: {alphaLevelAccess: ['<string>']},
beginDate: '<string>',
endDate: '<string>'
}
],
demographics: {
birthDate: '<string>',
americanIndianOrAlaskaNative: '<string>',
asian: '<string>',
blackOrAfricanAmerican: '<string>',
nativeHawaiianOrOtherPacificIslander: '<string>',
white: '<string>',
demographicRaceTwoOrMoreRaces: '<string>',
hispanicOrLatinoEthnicity: '<string>',
countryOfBirthCode: '<string>',
stateOfBirthAbbreviation: '<string>',
cityOfBirth: '<string>',
publicSchoolResidenceStatus: '<string>'
},
enabledUser: true
},
expectedDateLastModified: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'user' => [
'metadata' => [
'onboarding' => [
],
'isTestUser' => true,
'skipRosterImport' => true
],
'identifier' => '<string>',
'userMasterIdentifier' => '<string>',
'username' => '<string>',
'givenName' => '<string>',
'familyName' => '<string>',
'middleName' => '<string>',
'email' => 'jsmith@example.com',
'preferredFirstName' => '<string>',
'preferredMiddleName' => '<string>',
'preferredLastName' => '<string>',
'pronouns' => '<string>',
'grades' => [
],
'sms' => '<string>',
'phone' => '<string>',
'agents' => [
],
'roles' => [
[
'org' => [
'sourcedId' => '<string>'
],
'userProfile' => '<string>',
'metadata' => [
'alphaLevelAccess' => [
'<string>'
]
],
'beginDate' => '<string>',
'endDate' => '<string>'
]
],
'demographics' => [
'birthDate' => '<string>',
'americanIndianOrAlaskaNative' => '<string>',
'asian' => '<string>',
'blackOrAfricanAmerican' => '<string>',
'nativeHawaiianOrOtherPacificIslander' => '<string>',
'white' => '<string>',
'demographicRaceTwoOrMoreRaces' => '<string>',
'hispanicOrLatinoEthnicity' => '<string>',
'countryOfBirthCode' => '<string>',
'stateOfBirthAbbreviation' => '<string>',
'cityOfBirth' => '<string>',
'publicSchoolResidenceStatus' => '<string>'
],
'enabledUser' => true
],
'expectedDateLastModified' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}"
payload := strings.NewReader("{\n \"user\": {\n \"metadata\": {\n \"onboarding\": {},\n \"isTestUser\": true,\n \"skipRosterImport\": true\n },\n \"identifier\": \"<string>\",\n \"userMasterIdentifier\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"grades\": [],\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"agents\": [],\n \"roles\": [\n {\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"userProfile\": \"<string>\",\n \"metadata\": {\n \"alphaLevelAccess\": [\n \"<string>\"\n ]\n },\n \"beginDate\": \"<string>\",\n \"endDate\": \"<string>\"\n }\n ],\n \"demographics\": {\n \"birthDate\": \"<string>\",\n \"americanIndianOrAlaskaNative\": \"<string>\",\n \"asian\": \"<string>\",\n \"blackOrAfricanAmerican\": \"<string>\",\n \"nativeHawaiianOrOtherPacificIslander\": \"<string>\",\n \"white\": \"<string>\",\n \"demographicRaceTwoOrMoreRaces\": \"<string>\",\n \"hispanicOrLatinoEthnicity\": \"<string>\",\n \"countryOfBirthCode\": \"<string>\",\n \"stateOfBirthAbbreviation\": \"<string>\",\n \"cityOfBirth\": \"<string>\",\n \"publicSchoolResidenceStatus\": \"<string>\"\n },\n \"enabledUser\": true\n },\n \"expectedDateLastModified\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user\": {\n \"metadata\": {\n \"onboarding\": {},\n \"isTestUser\": true,\n \"skipRosterImport\": true\n },\n \"identifier\": \"<string>\",\n \"userMasterIdentifier\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"grades\": [],\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"agents\": [],\n \"roles\": [\n {\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"userProfile\": \"<string>\",\n \"metadata\": {\n \"alphaLevelAccess\": [\n \"<string>\"\n ]\n },\n \"beginDate\": \"<string>\",\n \"endDate\": \"<string>\"\n }\n ],\n \"demographics\": {\n \"birthDate\": \"<string>\",\n \"americanIndianOrAlaskaNative\": \"<string>\",\n \"asian\": \"<string>\",\n \"blackOrAfricanAmerican\": \"<string>\",\n \"nativeHawaiianOrOtherPacificIslander\": \"<string>\",\n \"white\": \"<string>\",\n \"demographicRaceTwoOrMoreRaces\": \"<string>\",\n \"hispanicOrLatinoEthnicity\": \"<string>\",\n \"countryOfBirthCode\": \"<string>\",\n \"stateOfBirthAbbreviation\": \"<string>\",\n \"cityOfBirth\": \"<string>\",\n \"publicSchoolResidenceStatus\": \"<string>\"\n },\n \"enabledUser\": true\n },\n \"expectedDateLastModified\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{sourcedId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": {\n \"metadata\": {\n \"onboarding\": {},\n \"isTestUser\": true,\n \"skipRosterImport\": true\n },\n \"identifier\": \"<string>\",\n \"userMasterIdentifier\": \"<string>\",\n \"username\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"middleName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"preferredFirstName\": \"<string>\",\n \"preferredMiddleName\": \"<string>\",\n \"preferredLastName\": \"<string>\",\n \"pronouns\": \"<string>\",\n \"grades\": [],\n \"sms\": \"<string>\",\n \"phone\": \"<string>\",\n \"agents\": [],\n \"roles\": [\n {\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"userProfile\": \"<string>\",\n \"metadata\": {\n \"alphaLevelAccess\": [\n \"<string>\"\n ]\n },\n \"beginDate\": \"<string>\",\n \"endDate\": \"<string>\"\n }\n ],\n \"demographics\": {\n \"birthDate\": \"<string>\",\n \"americanIndianOrAlaskaNative\": \"<string>\",\n \"asian\": \"<string>\",\n \"blackOrAfricanAmerican\": \"<string>\",\n \"nativeHawaiianOrOtherPacificIslander\": \"<string>\",\n \"white\": \"<string>\",\n \"demographicRaceTwoOrMoreRaces\": \"<string>\",\n \"hispanicOrLatinoEthnicity\": \"<string>\",\n \"countryOfBirthCode\": \"<string>\",\n \"stateOfBirthAbbreviation\": \"<string>\",\n \"cityOfBirth\": \"<string>\",\n \"publicSchoolResidenceStatus\": \"<string>\"\n },\n \"enabledUser\": true\n },\n \"expectedDateLastModified\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"user": {
"sourcedId": "<string>",
"status": "active",
"enabledUser": "true",
"givenName": "<string>",
"familyName": "<string>",
"roles": [],
"agents": [],
"userProfiles": [],
"email": "jsmith@example.com",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"userMasterIdentifier": "<string>",
"username": "<string>",
"userIds": [
{
"type": "<string>",
"identifier": "<string>"
}
],
"middleName": "<string>",
"primaryOrg": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"identifier": "<string>",
"preferredFirstName": "<string>",
"preferredMiddleName": "<string>",
"preferredLastName": "<string>",
"pronouns": "<string>",
"grades": [
"3"
],
"password": "<string>",
"sms": "<string>",
"phone": "<string>",
"demographics": {
"sourcedId": "<string>",
"status": "active",
"birthDate": "<string>",
"sex": "male",
"americanIndianOrAlaskaNative": "<string>",
"asian": "<string>",
"blackOrAfricanAmerican": "<string>",
"nativeHawaiianOrOtherPacificIslander": "<string>",
"white": "<string>",
"demographicRaceTwoOrMoreRaces": "<string>",
"hispanicOrLatinoEthnicity": "<string>",
"countryOfBirthCode": "<string>",
"stateOfBirthAbbreviation": "<string>",
"cityOfBirth": "<string>",
"publicSchoolResidenceStatus": "<string>",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {}
}
}
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "invaliddata"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "unauthorisedrequest"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "forbidden"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "unknownobject"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "invaliddata"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "invaliddata"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "server_busy"
}
]
},
"imsx_error_details": [
{}
]
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "internal_server_error"
}
]
},
"imsx_error_details": [
{}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The sourcedId of the user to update
Body
application/json
Response
User successfully updated
Represents a user of the system. Can be a student, teacher, guide, parent etc.
Show child attributes
Show child attributes
⌘I