> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.sare.africa/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.sare.africa/_mcp/server. # Update Role PUT http://localhost:8080/api/v3/roles/{id} Content-Type: application/json Reference: https://apidocs.sare.africa/sare-core-api/identity/update-role ## Request ### Path parameters - `id` (string, required) ### Headers - `Authorization` (string, optional) - `X-Device-Id` (string, optional) — Required on non-GET requests to non-public paths (DeviceSignatureFilter), skipped for GET/whitelisted/multipart requests and in the local profile. - `X-Signature` (string, optional) — Base64 ECDSA signature over sha256(body) + timestamp + requestId, signed with the device's registered private key. - `X-Timestamp` (string, optional) — Unix epoch seconds; must be within 5 minutes of server time. - `X-Request-Id` (string, optional) — Unique per request - reused values are rejected as replays. ### Body (application/json) This endpoint expects an object. - `name` (string, optional) - `description` (string, optional) - `permissionIds` (list of string, optional) ## Response ### 200 200 OK - `code` (integer, optional) - `message` (string, optional) - `data` (RolesIdPutResponsesContentApplicationJsonSchemaData, optional) ## Types ### RolesIdPutResponsesContentApplicationJsonSchemaData - `id` (string, optional) - `name` (string, optional) - `description` (string, optional) - `permissions` (list of RolesIdPutResponsesContentApplicationJsonSchemaDataPermissionsItems, optional) ### RolesIdPutResponsesContentApplicationJsonSchemaDataPermissionsItems - `id` (string, optional) - `name` (string, optional) ## Examples **Request** ```json { "name": "SALES_AGENT", "description": "Handles field sales", "permissionIds": [ "c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b" ] } ``` **Response** ```json { "code": 200, "message": "Role edited successfully", "data": { "id": "e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f", "name": "SALES_AGENT", "description": "Handles field sales", "permissions": [ { "id": "c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b", "name": "users:read" } ] } } ``` **SDK Code** ```python Identity_updateRole_example import requests url = "http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f" payload = { "name": "SALES_AGENT", "description": "Handles field sales", "permissionIds": ["c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b"] } headers = { "Authorization": "Bearer {{accessToken}}", "X-Device-Id": "{{deviceId}}", "X-Request-Id": "{{requestId}}", "X-Signature": "{{signature}}", "X-Timestamp": "{{timestamp}}", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Identity_updateRole_example const url = 'http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f'; const options = { method: 'PUT', headers: { Authorization: 'Bearer {{accessToken}}', 'X-Device-Id': '{{deviceId}}', 'X-Request-Id': '{{requestId}}', 'X-Signature': '{{signature}}', 'X-Timestamp': '{{timestamp}}', 'Content-Type': 'application/json' }, body: '{"name":"SALES_AGENT","description":"Handles field sales","permissionIds":["c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b"]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Identity_updateRole_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f" payload := strings.NewReader("{\n \"name\": \"SALES_AGENT\",\n \"description\": \"Handles field sales\",\n \"permissionIds\": [\n \"c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b\"\n ]\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer {{accessToken}}") req.Header.Add("X-Device-Id", "{{deviceId}}") req.Header.Add("X-Request-Id", "{{requestId}}") req.Header.Add("X-Signature", "{{signature}}") req.Header.Add("X-Timestamp", "{{timestamp}}") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Identity_updateRole_example require 'uri' require 'net/http' url = URI("http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f") http = Net::HTTP.new(url.host, url.port) request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer {{accessToken}}' request["X-Device-Id"] = '{{deviceId}}' request["X-Request-Id"] = '{{requestId}}' request["X-Signature"] = '{{signature}}' request["X-Timestamp"] = '{{timestamp}}' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"SALES_AGENT\",\n \"description\": \"Handles field sales\",\n \"permissionIds\": [\n \"c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b\"\n ]\n}" response = http.request(request) puts response.read_body ``` ```java Identity_updateRole_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f") .header("Authorization", "Bearer {{accessToken}}") .header("X-Device-Id", "{{deviceId}}") .header("X-Request-Id", "{{requestId}}") .header("X-Signature", "{{signature}}") .header("X-Timestamp", "{{timestamp}}") .header("Content-Type", "application/json") .body("{\n \"name\": \"SALES_AGENT\",\n \"description\": \"Handles field sales\",\n \"permissionIds\": [\n \"c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b\"\n ]\n}") .asString(); ``` ```php Identity_updateRole_example request('PUT', 'http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f', [ 'body' => '{ "name": "SALES_AGENT", "description": "Handles field sales", "permissionIds": [ "c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b" ] }', 'headers' => [ 'Authorization' => 'Bearer {{accessToken}}', 'Content-Type' => 'application/json', 'X-Device-Id' => '{{deviceId}}', 'X-Request-Id' => '{{requestId}}', 'X-Signature' => '{{signature}}', 'X-Timestamp' => '{{timestamp}}', ], ]); echo $response->getBody(); ``` ```csharp Identity_updateRole_example using RestSharp; var client = new RestClient("http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer {{accessToken}}"); request.AddHeader("X-Device-Id", "{{deviceId}}"); request.AddHeader("X-Request-Id", "{{requestId}}"); request.AddHeader("X-Signature", "{{signature}}"); request.AddHeader("X-Timestamp", "{{timestamp}}"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"SALES_AGENT\",\n \"description\": \"Handles field sales\",\n \"permissionIds\": [\n \"c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b\"\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Identity_updateRole_example import Foundation let headers = [ "Authorization": "Bearer {{accessToken}}", "X-Device-Id": "{{deviceId}}", "X-Request-Id": "{{requestId}}", "X-Signature": "{{signature}}", "X-Timestamp": "{{timestamp}}", "Content-Type": "application/json" ] let parameters = [ "name": "SALES_AGENT", "description": "Handles field sales", "permissionIds": ["c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b"] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v3/roles/e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```