Get the user data of a specific user or the authenticated user.

OpenAPI Updated 3.5

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}} curl --request GET \ --url 'http://localhost:7575/v2/users/{user-id}' \ --header 'Authorization: Bearer $TOKEN' ``` ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}} import json import requests url = "http://localhost:7575/v2/users/{user-id}" headers = {'Authorization': 'Bearer '} response = requests.request("GET", url, headers=headers) print(response.text) ``` ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}} const response = await fetch('http://localhost:7575/v2/users/{user-id}', { method: 'GET', headers: { "Authorization": "Bearer " }, }); console.log(await response.text()); ``` ```php PHP theme={"theme":{"light":"github-light","dark":"github-dark"}} 'http://localhost:7575/v2/users/{user-id}', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ "Authorization: Bearer " ], ]); $response = curl_exec($curl); echo $response; ``` ```go Go theme={"theme":{"light":"github-light","dark":"github-dark"}} package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "http://localhost:7575/v2/users/{user-id}", nil) req.Header.Set("Authorization", "Bearer ") response, _ := http.DefaultClient.Do(req) defer response.Body.Close() body, _ := io.ReadAll(response.Body) fmt.Println(string(body)) } ``` ```java Java theme={"theme":{"light":"github-light","dark":"github-dark"}} import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; var request = HttpRequest.newBuilder() .uri(URI.create("http://localhost:7575/v2/users/{user-id}")) .header("Authorization", "Bearer ") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); var response = HttpClient.newHttpClient().send( request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); ``` ```ruby Ruby theme={"theme":{"light":"github-light","dark":"github-dark"}} require 'net/http' require 'uri' uri = URI('http://localhost:7575/v2/users/{user-id}') request = Net::HTTP::Get.new(uri) request['Authorization'] = 'Bearer ' response = Net::HTTP.start(uri.hostname, uri.port) do |http| http.request(request) end puts response.body ``` ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}} { "user": { "id": "", "primaryParty": "", "isDeactivated": false, "metadata": { "resourceVersion": "", "annotations": {} }, "identityProviderId": "", "primaryPartyAuthentication": false } } ``` ```text 400 theme={"theme":{"light":"github-light","dark":"github-dark"}} ``` ```json default theme={"theme":{"light":"github-light","dark":"github-dark"}} { "code": "", "cause": "", "correlationId": "", "traceId": "", "context": {}, "resources": [ [ "" ] ], "errorCategory": 123, "grpcCodeValue": 123, "retryInfo": "", "definiteAnswer": false } ``` ## Authorizations ### httpAuth HTTP bearer authentication. Send the token as `Authorization: Bearer <token>`. Ledger API standard JWT token ### apiKeyAuth API key authentication in the header. Ledger API standard JWT token (websocket) ## Path parameters ## Query parameters ## Responses ### 200

application/json

Users and rights ///////////////// Users are used to dynamically manage the rights given to Daml applications. They are stored and managed per participant node. The user identifier, which must be a non-empty string of at most 128 characters that are either alphanumeric ASCII characters or one of the symbols "@^\$.!\`-#+'\~\_|:()". Required The primary party as which this user reads and acts by default on the ledger *provided* it has the corresponding `CanReadAs(primary_party)` or `CanActAs(primary_party)` rights. Ledger API clients SHOULD set this field to a non-empty value for all users to enable the users to act on the ledger using their own Daml party. Users for participant administrators MAY have an associated primary party. Modifiable Optional When set, then the user is denied all access to the Ledger API. Otherwise, the user has access to the Ledger API as per the user's rights. Modifiable Optional Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party). Based on `ObjectMeta` meta used in Kubernetes API. See [https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640](https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640) An opaque, non-empty value, populated by a participant server which represents the internal version of the resource this `ObjectMeta` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated. You must not rely on the format of resource version. The participant server might change it without notice. You can obtain the newest resource version value by issuing a read request. You may use it for concurrent change detection by passing it back unmodified in an update request. The participant server will then compare the passed value with the value maintained by the system to determine if any other updates took place since you had read the resource version. Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence. However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error. Concurrent change control is optional. It will be applied only if you include a resource version in an update request. When creating a new instance of a resource you must leave the resource version empty. Its value will be populated by the participant server upon successful resource creation. Optional A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata. Constraints: 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding. 2. Keys are composed of an optional prefix segment and a required name segment such that: - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character, - name segment must have at most 63 characters that are either alphanumeric (\[a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '\_' (underscore); and it must start and end with an alphanumeric character. 3. Values can be any non-empty strings. Keys with empty prefix are reserved for end-users. Properties set by external tools or internally by the participant server must use non-empty key prefixes. Duplicate keys are disallowed by the semantics of the protobuf3 maps. See: [https://developers.google.com/protocol-buffers/docs/proto3#maps](https://developers.google.com/protocol-buffers/docs/proto3#maps) Annotations may be a part of a modifiable resource. Use the resource's update RPC to update its annotations. In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request. In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request. Modifiable Optional: can be empty The ID of the identity provider configured by `Identity Provider Config` If not set, assume the user is managed by the default identity provider. Optional If set to true, the user may authenticate against the Ledger API by signing a Party JWT using the primary party's signing key. Modifiable Optional ### 400 Invalid value, Invalid value for: query parameter identity-provider-id

text/plain

### default

application/json

## History

Updated 3.5

The GET /v2/users/\{user-id} operation changed in this snapshot.