Skip to main content
GET
/
apps
/
{app_id}
/
access-requests
List all access requests for this application
curl --request GET \
  --url http://localhost:3001/portal-api/apps/{app_id}/access-requests \
  --header 'Authorization: <api-key>'
[
  {
    "Catalogue": "Public Catalogue",
    "Client": "Payment application",
    "CreatedAt": "2023-06-25 13:37",
    "UpdatedAt": "2023-06-25 13:37",
    "DeletedAt": "2023-06-25 13:37",
    "Plan": "Free plan",
    "User": "User#1",
    "AuthType": "authToken",
    "DCREnabled": false,
    "ID": 1,
    "ProvisionImmediately": true,
    "Products": "Payment API",
    "Credentials": [
      {
        "AccessRequest": "AccessRequest#2",
        "Credential": "eyJvcmciOiI1ZTlkOTU0NGExZGNkNjAwMDFkMGVkMjAiLCJpZCI6IjY4MjZjZGViMmVlMzQ3ZGQ5ZjQ1ZWZmMjEyMTlhOWU1IiwiaCI6Im11cm11cjY0In0=",
        "CredentialHash": "e1212449778b7ba4",
        "DCRRegistrationAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmZjIyNmYyZi0yMDA0LTRlOWItOTFmOC1iOGYzOTA2ZDJmYTQifQ.eyJleHAiOjAsImlhdCI6MTY4NzczNzM5MCwianRpIjoiNjc3OTgwYjktZjgwMS00MmQ2LWI4OTItZDdkNDk1MmFhMjU5IiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo5OTk5L3JlYWxtcy9tYXN0ZXIiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0Ojk5OTkvcmVhbG1zL21hc3RlciIsInR5cCI6IlJlZ2lzdHJhdGlvbkFjY2Vzc1Rva2VuIiwicmVnaXN0cmF0aW9uX2F1dGgiOiJhdXRoZW50aWNhdGVkIn0.wyE93vktqlCywgtyJ8HBTjRPG9NvZEDR3zpSMncdwno",
        "DCRRegistrationClientURI": "http://idp-host/realms/master/clients-registrations/openid-connect/cf4ab76c-c437-4ba2-8e94-1323269b5090",
        "DCRResponse": "{\"redirect_uris\":[\"http://app-host/auth\"],\"token_endpoint_auth_method\":\"client_secret_basic\",\"grant_types\":[\"implicit\",\"client_credentials\"],\"response_types\":[\"id_token\",\"id_token token\"],\"client_id\":\"cf4ab76c-c437-4ba2-8e94-1323269b5090\",\"client_secret\":\"iDe9fkFNBDbVS5JOtYNUDIO8w8N6dWzf\",\"client_name\":\"OAuth2.0 client\",\"scope\":\"address phone offline_access microprofile-jwt\",\"subject_type\":\"public\",\"request_uris\":[],\"tls_client_certificate_bound_access_tokens\":false,\"client_id_issued_at\":1687737390,\"client_secret_expires_at\":0,\"registration_client_uri\":\"http://idp-host/realms/master/clients-registrations/openid-connect/cf4ab76c-c437-4ba2-8e94-1323269b5090\",\"registration_access_token\":\"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmZjIyNmYyZi0yMDA0LTRlOWItOTFmOC1iOGYzOTA2ZDJmYTQifQ.eyJleHAiOjAsImlhdCI6MTY4NzczNzM5MCwianRpIjoiNjc3OTgwYjktZjgwMS00MmQ2LWI4OTItZDdkNDk1MmFhMjU5IiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo5OTk5L3JlYWxtcy9tYXN0ZXIiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0Ojk5OTkvcmVhbG1zL21hc3RlciIsInR5cCI6IlJlZ2lzdHJhdGlvbkFjY2Vzc1Rva2VuIiwicmVnaXN0cmF0aW9uX2F1dGgiOiJhdXRoZW50aWNhdGVkIn0.wyE93vktqlCywgtyJ8HBTjRPG9NvZEDR3zpSMncdwno\",\"backchannel_logout_session_required\":false,\"require_pushed_authorization_requests\":false,\"frontchannel_logout_session_required\":false}",
        "Expires": "1969-12-31 19:00",
        "OAuthClientID": "cf4ab76c-c437-4ba2-8e94-1323269b5090",
        "OAuthClientSecret": "iDe9fkFNBDbVS5JOtYNUDIO8w8N6dWzf",
        "RedirectURI": "https://app-host/auth",
        "ResponseType": "id_token token",
        "Scope": "payment client",
        "TokenEndpoints": "payment client"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
app_id
integer
required

UID of this application

Example:

1

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
Catalogue
string

Catalogue of API Products included in this access request

Example:

"Public Catalogue"

​
Client
string

Name of the developer app

Example:

"Payment application"

​
CreatedAt
string

Timestamp of when this access request was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

​
UpdatedAt
string

Timestamp of when this access request was updated the last time

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

​
DeletedAt
string

Timestamp of when this access request was removed

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

​
Plan
string

Name of a plan included in this access request

Example:

"Free plan"

​
User
string

Descriptor of a user to whom this access request belongs

Example:

"User#1"

​
AuthType
string

Authentication type of APIs that are included in this API Product

Example:

"authToken"

​
DCREnabled
boolean

Identifies if this access request was created using Dynamic client registration

Example:

false

​
ID
integer

UID of access request

Example:

1

​
ProvisionImmediately
boolean

Identifies if this access request was approved automatically

Example:

true

​
Status
enum<string>

Approval status of this access request

Available options:
approved,
rejected,
pending
​
Products
string

Names of products included in this access request

Example:

"Payment API"

​
Credentials
object[]