Get Consumer

GET /obp/v7.0.0/management/consumers/CONSUMER_ID

OBPv7.0.0-getConsumer Roles: CanGetConsumers Consumer

Get the Consumer specified by CONSUMER_ID, with its active rate limits and current call counters.

The response has no consumer_key and no consumer_secret: both are credentials.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields (42)

active_at_date: active_at_date
active_per_day_rate_limit: active_per_day_rate_limit
active_per_hour_rate_limit: active_per_hour_rate_limit
active_per_minute_rate_limit: active_per_minute_rate_limit
active_per_month_rate_limit: active_per_month_rate_limit
active_per_second_rate_limit: active_per_second_rate_limit
active_per_week_rate_limit: active_per_week_rate_limit
active_rate_limits: active_rate_limits
app_name: appNameBank
app_type: Web
call_counters: call_counters
certificate_pem: certificate_pem
company: Tesobe GmbH
considered_rate_limit_ids: considered_rate_limit_ids
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
created
created_by_user
description: Description of the object. Maximum length is 2000. It can be any characters here.
developer_email
email: felixsmith@example.com
enabled: false
issuer_domain_name: issuer_domain_name
not_after: not_after
not_before: not_before
per_day: 4000
per_hour
per_minute
per_month: 500
per_second: 1000
per_week: 50000
provider: ETHEREUM
provider_id
redirect_url: https://apisandbox.openbankproject.com
status
subject_domain_name: subject_domain_name
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
calls_made: 50
certificate_info: certificate_info
logo_url: logo_url
reset_in_seconds
roles_info: roles_info

Example success response

{
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "app_name": "appNameBank",
  "app_type": "Web",
  "description": "Description of the object. Maximum length is 2000. It can be any characters here.",
  "developer_email": "felixsmith@example.com",
  "company": "Tesobe GmbH",
  "redirect_url": "https://apisandbox.openbankproject.com",
  "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n",
  "certificate_info": {
    "subject_domain_name": "OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE",
    "issuer_domain_name": "CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE",
    "not_before": "2022-04-01T10:13:00.000Z",
    "not_after": "2032-04-01T10:13:00.000Z",
    "roles_info": "PEM Encoded Certificate does not contain PSD2 roles."
  },
  "created_by_user": {
    "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email": "felixsmith@example.com",
    "provider_id": "Chris",
    "provider": "http://127.0.0.1:8080",
    "username": "felixsmith"
  },
  "enabled": true,
  "created": "1100-01-01T00:00:00Z",
  "logo_url": "https://apisandbox.openbankproject.com/logo",
  "active_rate_limits": {
    "considered_rate_limit_ids": [
      "80e1e0b2-d8bf-4f85-a579-e69ef36e3305"
    ],
    "active_at_date": "1100-01-01T00:00:00Z",
    "active_per_second_rate_limit": 100,
    "active_per_minute_rate_limit": 1000,
    "active_per_hour_rate_limit": -1,
    "active_per_day_rate_limit": -1,
    "active_per_week_rate_limit": -1,
    "active_per_month_rate_limit": -1
  },
  "call_counters": {
    "per_second": {
      "calls_made": 42,
      "reset_in_seconds": 15,
      "status": "ACTIVE"
    },
    "per_minute": {
      "calls_made": 42,
      "reset_in_seconds": 15,
      "status": "ACTIVE"
    },
    "per_hour": {
      "calls_made": 42,
      "reset_in_seconds": 15,
      "status": "ACTIVE"
    },
    "per_day": {
      "calls_made": 42,
      "reset_in_seconds": 15,
      "status": "ACTIVE"
    },
    "per_week": {
      "calls_made": 42,
      "reset_in_seconds": 15,
      "status": "ACTIVE"
    },
    "per_month": {
      "calls_made": 42,
      "reset_in_seconds": 15,
      "status": "ACTIVE"
    }
  }
}

Possible errors (4)

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
OBP-50000: Unknown Error.