Skip to main content
GET
/
ims
/
oneroster
/
rostering
/
v1p2
/
users
/
{userId}
/
agents
Get agents for a user
curl --request GET \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/users/{userId}/agents \
  --header 'Authorization: Bearer <token>'
{
  "agents": [
    {
      "sourcedId": "<string>",
      "status": "active",
      "enabledUser": "true",
      "givenName": "<string>",
      "familyName": "<string>",
      "roles": [],
      "agents": [],
      "userProfiles": [],
      "email": "[email protected]",
      "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": {}
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

The sourcedId of the user

Response

Successfully retrieved agents for user

agents
object[]
required