Sessions v2
Claim a role
Claims a role on a session server for a user and returns the normalized claim.
POST
/
sessions
/
v2
/
{sessionId}
/
servers
/
{serverId}
/
claims
Claim a role
curl --request POST \
--url https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims \
--header 'Content-Type: application/json' \
--header 'loader-id: <api-key>' \
--data '
{
"userId": "<string>",
"roleGroupId": "<string>",
"roleId": "<string>"
}
'import requests
url = "https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims"
payload = {
"userId": "<string>",
"roleGroupId": "<string>",
"roleId": "<string>"
}
headers = {
"loader-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'loader-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({userId: '<string>', roleGroupId: '<string>', roleId: '<string>'})
};
fetch('https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '<string>',
'roleGroupId' => '<string>',
'roleId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"loader-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"roleGroupId\": \"<string>\",\n \"roleId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("loader-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims")
.header("loader-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"roleGroupId\": \"<string>\",\n \"roleId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["loader-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"roleGroupId\": \"<string>\",\n \"roleId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"userId": "<string>",
"roleId": "<string>",
"roleName": "<string>",
"claimedBy": "<string>",
"claimedAt": "2023-11-07T05:31:56Z",
"claimId": "<string>"
}
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}Authorizations
Body
application/json
Previous
Release a claimReleases a user's claim on a session server and recomputes the session claim list.
Next
⌘I
Claim a role
curl --request POST \
--url https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims \
--header 'Content-Type: application/json' \
--header 'loader-id: <api-key>' \
--data '
{
"userId": "<string>",
"roleGroupId": "<string>",
"roleId": "<string>"
}
'import requests
url = "https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims"
payload = {
"userId": "<string>",
"roleGroupId": "<string>",
"roleId": "<string>"
}
headers = {
"loader-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'loader-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({userId: '<string>', roleGroupId: '<string>', roleId: '<string>'})
};
fetch('https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '<string>',
'roleGroupId' => '<string>',
'roleId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"loader-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"roleGroupId\": \"<string>\",\n \"roleId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("loader-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims")
.header("loader-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"roleGroupId\": \"<string>\",\n \"roleId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["loader-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"roleGroupId\": \"<string>\",\n \"roleId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"userId": "<string>",
"roleId": "<string>",
"roleName": "<string>",
"claimedBy": "<string>",
"claimedAt": "2023-11-07T05:31:56Z",
"claimId": "<string>"
}
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}{
"success": false,
"reason": "<string>"
}