Read All Digital Wallets

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets

Use the GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets operation to return all the digital wallets for the specified user in the specified environment.

Prerequisites

Create a user to get a userID for the endpoint. Refer also to Users, especially User operations.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

GET /environments/{{envID}}/users/{{userID}}/digitalWallets HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}/digitalWallets")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/digitalWallets"
        }
    },
    "_embedded": {
        "digitalWallets": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/digitalWallets/17b5b514-623f-4700-8a20-c8df1a1eaadb"
                    }
                },
                "id": "17b5b514-623f-4700-8a20-c8df1a1eaadb",
                "createdAt": "2023-02-10T16:55:46.541Z",
                "updatedAt": "2023-02-10T16:56:51.605Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "49825b76-e1df-4cdc-b973-0c580f1cb049"
                },
                "digitalWalletApplication": {
                    "id": "6815c8a6-bc0b-4105-8f37-50f6c35583d7"
                },
                "status": "PAIRING_REQUIRED"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/49825b76-e1df-4cdc-b973-0c580f1cb049/digitalWallets/46e7018d-b2d5-482f-a44c-3fa9dd34e7d9"
                    }
                },
                "id": "46e7018d-b2d5-482f-a44c-3fa9dd34e7d9",
                "createdAt": "2023-02-10T14:46:24.669Z",
                "updatedAt": "2023-02-13T15:24:32.401Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "49825b76-e1df-4cdc-b973-0c580f1cb049"
                },
                "digitalWalletApplication": {
                    "id": "9f698462-21d5-4fd6-8599-c2b56683eb57"
                },
                "status": "EXPIRED",
                "notification": {
                    "methods": [
                        "EMAIL",
                        "SMS"
                    ],
                    "template": {
                        "locale": "en",
                        "variant": "variant_B"
                    },
                    "results": [
                        {
                            "method": "EMAIL",
                            "sent": true,
                            "notification": {
                                "id": "00a9e836-c339-4763-ab69-fcd3aa9c5417"
                            }
                        },
                        {
                            "method": "SMS",
                            "sent": false,
                            "error": {
                                "id": "17c006ef-9e5f-443b-b883-86f0855aa936",
                                "code": "INVALID_DATA",
                                "message": "The request could not be completed. One or more validation errors were in the request.",
                                "details": [
                                    {
                                        "code": "INVALID_VALUE",
                                        "message": "Could not find phone attribute for user 49825b76-e1df-4cdc-b973-0c580f1cb049."
                                    }
                                ]
                            }
                        }
                    ]
                },
                "pairingAttempts": [
                    {
                        "success": false,
                        "error": "APP_PACKAGE_MISMATCH",
                        "message": "<english message>",
                        "details": {
                            "appPackage": "com.pingidentity.pingonewallet.sample"
                        },
                        "attemptedAt": "2023-02-11T08:26:38.438Z"
                    }
                ]
            }
        ]
    },
    "size": 2
}