Valence (September 2014)

Users (user data, whoami)

«  Permissions   ·  [   home  ·   forums  ·   reference   ·  index   ·  routing table   ·  modules   ]   ·  Demographics (data types, fields, users and org units)  »

Contents

Users are the people participating in the Learning Platform’s services. There are a few actions that operate directly upon user entities themselves, but most often they appear as factors in various other actions, identified by their associated UserId property (for example, the actions you’d use to find the courses a user is enrolled in are associated more directly with the enrollment and course resources).

Attributes

User.User

This structure gets used as a composite to include in resource blocks returned by a variety of services (for example, enrollments).

{
    "Identifier": <string>|null,
    "DisplayName": <string>|null,
    "EmailAddress": <string>|null,
    "OrgDefinedId": <string>|null,
    "ProfileBadgeUrl": <string>|null,
    "ProfileIdentifier": <string>|null
}
Identifier
This property can be missing depending on permissions afforded the caller’s context. If it’s missing, then it’s likely that the rest of the properties will also be null.
User.CreateUserData

When you use an action to create a user, you pass in a block of new-user data like this:

{
    "OrgDefinedId": <string>,
    "FirstName": <string>,
    "MiddleName": <string>,
    "LastName": <string>,
    "ExternalEmail": <string>|null,
    "UserName": <string>,
    "RoleId": <number>,
    "IsActive": <boolean>,
    "SendCreationEmail": <boolean>
}
ExternalEmail
Your block of new-user data must either have a null value (if the user has no external email address) or it must have a well-formed email address in this field (if present, the service depends upon this email address to send password reset and/or account creation email to the new user). If you’re creating a utility user account, then you should provide the email address of an administration contact for that utility account.

Note

Note that none of these properties are optional. For example, even if you’re trying to create a user without a middle name, you should still provide a MiddleName property (even if it’s an empty string).

User.UpdateUserData

When you use an action to update a user’s data, you pass in a block like this:

{
    "OrgDefinedId": <string>,
    "FirstName": <string>,
    "MiddleName": <string>,
    "LastName": <string>,
    "ExternalEmail": <string>,
    "UserName": <string>,
    "Activation": { <composite:User.UserActivationData> }
}
User.UserActivationData
{
    "IsActive": <boolean>
}
User.UserData

When you use an action with the User Management service to retrieve a user’s data, the service passes you back a data block like this (notice that it’s different to the User.WhoAmIUser information block provided by the WhoAmI service actions):

{
    "OrgId": <number:D2LID>,
    "UserId": <number:D2LID>,
    "FirstName": <string>,
    "MiddleName": <string>,
    "LastName": <string>,
    "UserName": <string>,
    "ExternalEmail": <string>,
    "OrgDefinedId": <string>,
    "UniqueIdentifier": <string>,
    "Activation": { <composite:User.UserActivationData> }
}
User.UserPasswordData
{
    "Password": <string>
}
User.WhoAmIUser

This user information block is the one handled by the WhoAmI service actions (notice that it’s different to the User.UserData information block handled by the User Management service actions).

{
    "Identifier": <string:D2LID>,
    "FirstName": <string>,
    "LastName": <string>,
    "UniqueName": <string>,
    "ProfileIdentifier": <string:D2LID>
}

Notifications

Notifications.CarrierOutput

This block contains identifying data for a carrying channel for delivering notification messages to the user (for example, email, SMS, Campus Life, and so forth).

{
    "CarrierId": <string:GUID>,
    "DisplayName": <string>
}
Notifications.SubscriptionOutput

This block contains identifying data for a single subscription to a particular type of messages provided by a particular LMS tool (for example, Dropbox, News, and so forth).

{
    "MessageTypeId": <string:GUID>,
    "ToolName": <string>,
    "MessageTypeDescription": <string>,
    "Subscribed": <boolean>
}

Profiles

User.UserProfile

This block contains a user’s personal profile data.

{
    "Nickname": <string>,
    "Birthday": {
        "Month": <number>,
        "Day": <number>
    },
    "HomeTown": <string>,
    "Email": <string>,
    "HomePage": <string>,
    "HomePhone": <string>,
    "BusinessPhone": <string>,
    "MobilePhone": <string>,
    "FaxNumber": <string>,
    "Address1": <string>,
    "Address2": <string>,
    "City": <string>,
    "Province": <string>,
    "PostalCode": <string>,
    "Country": <string>,
    "Company": <string>,
    "JobTitle": <string>,
    "HighSchool": <string>,
    "University": <string>,
    "Hobbies": <string>,
    "FavMusic": <string>,
    "FavTVShows": <string>,
    "FavMovies": <string>,
    "FavBooks": <string>,
    "FavQuotations": <string>,
    "FavWebSites": <string>,
    "FutureGoals": <string>,
    "FavMemory": <string>,
    "SocialMediaUrls": [ // Array of SocialMediaUrl blocks
        {
              "Name": <string>,
              "Url": <string:URL>
        },
        { <composite:SocialMediaUrl> }, ...
    ]
}

Profile images. As they’re binary data, profile images get provided, or fetched, directly and not as part of the UserProfile JSON structure. Clients can provide any valid image file that’s typically renderable in a browser (for example, JPEG, GIF, or PNG). The back-end service expects to receive a file named “profileImage”, but is not case-sensitive (so “PROFILEIMAGE” will also work, as will “ProfileImage”).

The actions that retrieve a user’s profile image let you specify an expected size, prompting the service to re-size the image to a useful dimension. You may want to perform ad-hoc testing against your back-end service to determine the best sizes to ask for: the service will send you back an image that’s at least as large on each side (in pixels) as the size value you provide.

Currently, the default size for the profile image is 300 pixels in height and width.

The routes that retrieve profile image data accept a thumbnail size parameter, accepted in version 1.0+ routes of LP v5.0.0. This parameter is also present in v1.0 routes on LP v4.5.0 as of service pack 4 (April 2012).

Roles

User.Role

This block describes a user role that you can assign to an enrolled user.

{
    "Identifier": <string>,
    "DisplayName": <string>,
    "Code": <string>
}

Actions

DELETE /d2l/api/lp/(version)/users/(userId)

Delete a particular user.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to delete users.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Note

This action is subject to user privacy controls. The calling user context must belong to a role granted permission to see all fields in a user’s entry.

GET /d2l/api/lp/(version)/users/

Retrieve data for one or more users.

Parameters:
Query Parameters:
 
  • orgDefinedId (string) – Optional. Org-defined identifier to look for.
  • userName (string) – Optional. User name to look for.
  • bookmark (string) – Optional. Bookmark to use for fetching next data set segment.
Status Codes:
  • 200 – Action succeeded.
  • 403 – Attempted to use orgDefinedId or userName parameters without permission to see those fields.
  • 404 – Attempted to use orgDefinedId or userName parameters, but no user found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. You can use this action in a number of different ways, depending upon the query parameters you provide. If you provide more than one of these parameters, this action selects among them in this order, regardless of the order you provide them in your URL:

orgDefinedId. Find all users that have this org-defined ID string. Fetch the results in a JSON array.

userName. Find the single user that has this user name.

bookmark. Use a paged result set to return the results. Fetch the segment of results immediately following your bookmark.

If you provide none of these query parameters, this action behaves as if you’d passed an empty value for the bookmark parameter: it fetches the first segment of results.

Return. If you use this action to find a single user’s data by userName, this route action a single UserData JSON block if successful, and a 404 Not Found if it cannot find a matching user.

If you use this action to find data for the users matching your provided orgDefinedId, this action returns a JSON array of UserData blocks (if only one user matches, the call returns a single-element array), and a 404 Not Found if it cannot find a matching user.

If you don’t provide either the orgDefinedId or userName parameter, then this action returns a paged result set containing the resulting user data blocks for the segment following your bookmark parameter (or the first segment if that parameter is empty or missing), or an empty result set if it cannot find a matching user.

Note that this action uses the UserId property as the paging control value. You can fetch the segment of results following any user’s entry in the entire data set by passing that user’s UserId as the bookmark value.

Note

This action is subject to user privacy controls. If the caller provides no query parameters, this method returns only the users with roles the caller’s role has permission to see, and additionally, will send back values only for the fields that the calling user role has permission to see (like first name, last name, and so forth). If the caller attempts to use the userName or orgDefinedId query parameters on this call, then the caller must have permission to see those fields or the service will reject the call with a 403 (no permission).

GET /d2l/api/lp/(version)/users/(userId)

Retrieve data for a particular user.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see user data.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a UserData JSON block.

Note

This action is subject to user privacy controls. The calling user context must belong to a role granted permission to see all fields in a user’s entry.

GET /d2l/api/lp/(version)/users/whoami

Retrieve the current user context’s user information.

Parameters:
Status Codes:
  • 200 – WhoAmI service user information block for the current user context.
  • 403 – No permission to see whoami information for current user context.
  • 404 – Could not map current user context to a known user ID.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a WhoAmIUser JSON block for the current user context.

POST /d2l/api/lp/(version)/users/

Create a new user entity.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid user data provided, or user creation request failed.
  • 403 – No permission to create users.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a UserData JSON block for the newly created user, to give you immediate access to the user’s UserId property.

Note

This action is subject to user privacy controls. The calling user context must belong to a role granted permission to see all fields in a user’s entry.

PUT /d2l/api/lp/(version)/users/(userId)

Update data for a particular user.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid user data provided.
  • 403 – No permission to update user data.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. Note that your provided block’s data replaces all the associated user’s data on the service.

Return. This action returns a UserData JSON block for the user’s updated data.

Note

This action is subject to user privacy controls. The calling user context must belong to a role granted permission to see all fields in a user’s entry.

Activation

GET /d2l/api/lp/(version)/users/(userId)/activation

Retrieve a particular user’s activation settings.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a UserActivationData JSON block with the user’s current activation status.

PUT /d2l/api/lp/(version)/users/(userId)/activation

Update a particular user’s activation settings.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Notifications

These routes depend upon the back-end service having the Notifications tool active. If the service does not have the Notifications tool active, then all calls to these routes will result in authorization (403) error results.

DELETE /d2l/api/lp/(version)/notifications/instant/carriers/(carrierId)/subscriptions/(messageTypeId)

Delete the subscription for messages of a particular type, delivered by a particular carrier.

Parameters:
  • version (D2LVERSION) – API version.
  • carrierId (GUID) – Notification carrier ID.
  • messageTypeId (GUID) – Message type ID.
Status Codes:
  • 200 – Action succeeded
  • 403 – Notification carrier disabled, or no permission to subscribe to notification messages, or no permissions for provided notification message type.
  • 404 – No such notification carrier, or carrier does not support messages of provided type.
API Versions:
  • 1.2+ – Route first appears in LMS v10.1.0.
GET /d2l/api/lp/(version)/notifications/instant/carriers/

Retrieve all the carrier channels for delivering notification messages.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to subscribe to notification messages.
API Versions:
  • 1.2+ – Route first appears in LMS v10.1.0.

Returns. This action returns a JSON array of CarrierOutput data blocks.

GET /d2l/api/lp/(version)/notifications/instant/carriers/(carrierId)/subscriptions/

Retrieve all the current subscriptions for notification messages.

Parameters:
  • version (D2LVERSION) – API version.
  • carrierId (GUID) – Notification carrier ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – Notification carrier disabled, or no permission to subscribe to notification messages.
  • 404 – No such notification carrier.
API Versions:
  • 1.2+ – Route first appears in LMS v10.1.0.

Returns. This action returns a JSON array of SubscriptionOutput data blocks.

PUT /d2l/api/lp/(version)/notifications/instant/carriers/(carrierId)/subscriptions/(messageTypeId)

Subscribe to notification messages of a particular type, delivered by a particular carrier.

Parameters:
  • version (D2LVERSION) – API version.
  • carrierId (GUID) – Notification carrier ID.
  • messageTypeId (GUID) – Message type ID.
Status Codes:
  • 200 – Action succeeded
  • 403 – Notification carrier disabled, or no permission to subscribe to notification messages, or no permissions for provided notification message type.
  • 404 – No such notification carrier, or carrier does not support messages of provided type.
API Versions:
  • 1.2+ – Route first appears in LMS v10.1.0.

Passwords

These routes give you some control over a user’s password. Note that the calling user context must have the appropriate permissions for password management for these calls to be useful.

DELETE /d2l/api/lp/(version)/users/(userId)/password

Clear a particular user’s password.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to control the user’s password.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

This action deletes a user’s current password.

POST /d2l/api/lp/(version)/users/(userId)/password

Reset a particular user’s password.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 400 – Could not send password-reset email.
  • 403 – No permission to control the user’s password.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

This action prompts the service to send a password-reset email to the provided user.

PUT /d2l/api/lp/(version)/users/(userId)/password

Update a particular user’s password.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid password provided
  • 403 – No permission to control the user’s password.
  • 404 – No such user.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

The site admin for the back-end service can configure the characteristics for a valid password, and the API doesn’t provide a way to fetch these characteristics; rather than checking for a valid password form on the client side, we suggest that callers notice invalid new passwords based on the 400 error returned (invalid password provided) and then suggest the user should contact the site admin for guidance on how to submit a well-formed password.

Profiles

Profile actions involve a user’s personal profile resource. Note that the UserProfile data block does not contain a ProfileId property itself. When you need to use this property to identify a particular user’s personal profile, you must use the ProfileIdentifier property found in the User.WhoAmIUser and User.User resources. Unlike D2LID values, a user’s ProfileId is an opaque string value.

DELETE /d2l/api/lp/(version)/profile/myProfile/image

Remove the current user’s profile image.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to edit personal profile for the current user context.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
DELETE /d2l/api/lp/(version)/profile/(profileId)/image

Remove the profile image from a particular personal profile, by Profile ID.

Parameters:
  • version (D2LVERSION) – API version.
  • profileId (string) – Profile ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to edit identified personal profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
DELETE /d2l/api/lp/(version)/profile/user/(userId)/image

Remove the profile image from a particular personal profile, by User ID.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to edit identified personal profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Note

In order to use this action, the service must have granted the application specific permission to do so (that is, granted permission to the specific application ID and key to attempt this action).

GET /d2l/api/lp/(version)/profile/myProfile

Retrieve personal profile information for the current user context.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see personal profile for the current user context.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a UserProfile JSON data block.

GET /d2l/api/lp/(version)/profile/myProfile/image

Retrieve the current user’s profile image.

Parameters:
Query Parameters:
 
  • size (integer) – Optional. Desired thumbnail size (height and width in pixels) for profile image.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see personal profile for the current user context.
  • 404 – Current user has no profile image.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.0+ – Size parameter added in LMS v10.0.0 (also deployed in LMS v9.4.1 as of service pack 4).
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a file stream containing the current user’s profile image. Note that the back-end service may return a profile image larger than your provided size.

GET /d2l/api/lp/(version)/profile/(profileId)

Retrieve a particular personal profile, by Profile ID.

Parameters:
  • version (D2LVERSION) – API version.
  • profileId (string) – Profile ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see identified personal profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns the UserProfile JSON data block corresponding to your provided Profile ID.

GET /d2l/api/lp/(version)/profile/(profileId)/image

Retrieve a particular profile image, by Profile ID.

Parameters:
  • version (D2LVERSION) – API version.
  • profileId (string) – Profile ID.
Query Parameters:
 
  • size (integer) – Optional. Desired thumbnail size (height and width in pixels) for profile image.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see identified personal profile.
  • 404 – Profile not found, or profile has no associated profile image.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.0+ – Size parameter added in LMS v10.0.0 (also deployed in LMS v9.4.1 as of service pack 4).
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a file stream containing the profile image for the identified profile. Note that the back-end service may return a profile image larger than your provided size.

GET /d2l/api/lp/(version)/profile/user/(userId)

Retrieve a particular personal profile, by User ID.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see the identified user’s personal profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns the UserProfile JSON data block containing the personal profile for your provided user.

Note

In order to use this action, the service must have granted the application specific permission to do so (that is, granted permission to the specific application ID and key used to attempt this action).

GET /d2l/api/lp/(version)/profile/user/(userId)/image

Retrieve a particular profile image, by User ID.

Parameters:
Query Parameters:
 
  • size (integer) – Optional. Desired thumbnail size (height and width in pixels) for profile image.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see the identified user’s personal profile.
  • 404 – Profile not found, or profile has no associated profile image.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.0+ – Size parameter added in LMS v10.0.0 (also deployed in LMS v9.4.1 as of service pack 4).
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a file stream containing the profile image for the identified profile. Note that the back-end service may return a profile image larger than your provided size.

Note

In order to use this action, the service must have granted the application specific permission to do so (that is, granted permission to the specific application ID and key used to attempt this action).

POST /d2l/api/lp/(version)/profile/myProfile/image

Update the personal profile image for the current user context.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to edit profile.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. Provide an uploaded image file; you must name the file profileImage.

POST /d2l/api/lp/(version)/profile/(profileId)/image

Update the profile image for the identified personal profile, by Profile ID.

Parameters:
  • version (D2LVERSION) – API version.
  • profileId (string) – Profile ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to edit profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. Provide an uploaded image file; you must name the file profileImage.

POST /d2l/api/lp/(version)/profile/user/(userId)/image

Update the profile image for the identified personal profile, by User ID.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to edit profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. Provide an uploaded image file; you must name the file profileImage.

Note

In order to use this action, the service must have granted the application specific permission to do so (that is, granted permission to the specific application ID and key to attempt this action).

PUT /d2l/api/lp/(version)/profile/myProfile

Update the personal profile data for the current user context.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid user profile data provided.
  • 403 – No permission to edit profile.
  • 404 – No personal profile found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. Note that your provided block’s data replaces all the associated user’s profile data on the service.

Return. This action returns a UserProfile JSON data block containing the updated personal profile data for the current user.

PUT /d2l/api/lp/(version)/profile/(profileId)

Update a particular personal profile, by Profile ID.

Parameters:
  • version (D2LVERSION) – API version.
  • profileId (string) – Profile ID.
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid user profile data provided.
  • 403 – No permission to update profile.
  • 404 – Profile not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. Note that your provided block’s data replaces all the associated user’s profile data on the service.

Return. This action returns a UserProfile JSON data block for the updated personal profile.

Roles

GET /d2l/api/lp/(version)/roles/

Retrieve a list of all known user roles.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage user roles.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a JSON array of Role data blocks containing the properties of all user roles that the calling user context has permission to manage.

GET /d2l/api/lp/(version)/roles/(roleId)

Retrieve a particular user role.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage user roles.
  • 404 – Role not found, or no permission to manage identified role.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a Role JSON data block for the identified user role.


«  Permissions   ·  [   home  ·   forums  ·   reference   ·  index   ·  routing table   ·  modules   ]   ·  Demographics (data types, fields, users and org units)  »