Contents

Read a user

Read a user in an Apple School Manager organization.

URL

GET https://api-school.apple.com/rosterapi/v1/users/{userId}

Path Parameters

NameTypeDescription
userId Requiredstring

The identifier from the user. Use the id field from the User object.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
User

The request was successful.

401Unauthorized

The access token was invalid.

403Forbidden

Access to the requested user was forbidden.

404Not Found

The server didn’t find a user with the given userId in the organization.

429

The client made too many requests. The response includes an X-Retry-After header that indicates the number of seconds to wait before making another request.

500Internal Server Error

The server encountered an internal error.

Mentioned in

Discussion

Access to the users resource requires authorization to the edu.users.read scope.

Example

See Also

Information about users