Check Global Username

An overview of the Check Global Username endpoint.

Endpoint Description

This endpoint validates the availability of a username across the R1 Discover platform, ensuring uniqueness for new user or admin account creation. It serves to prevent username conflicts by verifying that no existing user or admin has already registered the requested username.

HTTP Method

GET/api/v2/usernames/check/global/{username}

Request

Headers

• Content-Type: application/json

• Accept: application/json

• Authorization: Bearer {token}

URL Parameters

• username (string): The desired username to check for availability.

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v2/usernames/check/global/xyz123" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"

JavaScript

const url = new URL(
    "https://api.r1learning.com/api/v2/usernames/check/global/xyz123"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.r1learning.com/api/v2/usernames/check/global/xyz123");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer {token}");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

Data Dictionary

• username (string): The validated global username in the R1 Discover system.

• is_available (boolean): Returns true/false to indicate username availability

• message (string): Simple message indicated availability.

Response Examples

200: OK

[
    {
        "username": "testUser",
        "is_available": false,
        "message": "Username is not available"
    },
    {
        "username": "testUser2",
        "is_available": true,
        "message": "Username is available"
    }
]

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/525hmb9/check-global-usernamewww.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.

• Data Validation: Usernames must be checked prior to creating new accounts to ensure they are not in use. Ensure to encode the username in the URL if it includes special characters or spaces.