Update Admin/User Unique ID

An overview of the Update Admin/User Unique ID

Endpoint Description

THe utlity endpoint enables the update of the shared unique ID of a user/admin within the R1 Discover platform. In the event an integration partner needs to add or update the shared unique ID, that can be done with this endpoint leveraging the R1 DIscover unique ID.

HTTP Method

PUT /api/v2/users/{id}/uniqueId

Request

Headers:

• Content-Type: application/json - Specifies that the request body format is JSON.

• Accept: application/json - Indicates that the client expects a JSON response.

• Authorization: Bearer {token} - A valid Bearer token must be provided to authenticate the request.

URL Parameters

• id (integer, required): The R1 Discover platform id of the user/admin to update. Example: 1234

Body Parameters:

• uniqueId (string, required): The new/updated unique id for the user/admin.

Request Examples

Bash

curl --request POST \
    "https://api.r1learning.com/api/v2/users/1/uniqueId" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"unique_id\": \"r1-user-1234\"
}"

JavaScript

const url = new URL(
    "https://api.r1learning.com/api/v2/users/1/uniqueId"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {token}",
};

let body = {
    "unique_id": "r1-user-1234"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.r1learning.com/api/v2/users/1/uniqueId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer {token}");
var content = new StringContent("{\"unique_id\":\"r1-user-1234\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

Data Dictionary:

• id (Integer): The unique identifier for user/admin within the R1 Discover system.

• unique_id (string): The new unique_id (shared integration partner id) of the user/admin.

Response Examples

200: OK

{
    "message": "Unique ID Updated Successfully",
    "data": {
        "id": 32687,
        "unique_id": "r1-admin-example"
    }
}

401: Unauthorized

{
    "error": 1,
    "message": "Unauthenticated",
    "details": "Authentication is required to access this resource."
}

403: Unauthorized

{
    "error": 1,
    "message": "Unauthorized",
    "details": "You do not have the necessary permissions to perform this action."
}

Postman Link

https://www.postman.com/fbomher/r1-discover-api/request/uy1ph6y/update-admin-user-unique-idwww.postman.com

Link to the endpoint in Postman

Notes

• Authorization Required: Ensure the provided Bearer token is valid and has sufficient privileges to access the endpoint.