PUT
/
apps
/
{app_id}
Update an application
curl --request PUT \
  --url http://localhost:3001/portal-api/apps/{app_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Name": "Payment App",
  "Description": "This is my payment application",
  "RedirectURLs": "https://app-host/auth",
  "UserID": 1,
  "Visibility": "personal"
}'
{
  "Name": "Payment App",
  "Description": "This is my payment application",
  "RedirectURLs": "https://app-host/auth",
  "UserID": 1,
  "Visibility": "personal",
  "ID": 1,
  "CreatedAt": "2023-06-25 13:37",
  "AccessRequests": [
    [
      {
        "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,
        "Status": "approved",
        "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

Body

application/json
​
Name
string

Name of this application

Example:

"Payment App"

​
Description
string

Human-readable description of this application

Example:

"This is my payment application"

​
RedirectURLs
string

Redirect URL for OAuth2.0 authorization_code and PKCE grant types

Example:

"https://app-host/auth"

​
UserID
integer

UID of a user to whom this application will belong

Example:

1

​
Visibility
enum<string>
default:organisation

Controls who can access this application. Options are: personal (visible only to you), team (shared with your team), and organisation (accessible to all members of your organisation).

Available options:
personal,
team,
organisation
Example:

"personal"

Response

OK

​
Name
string

Name of this application

Example:

"Payment App"

​
Description
string

Human-readable description of this application

Example:

"This is my payment application"

​
RedirectURLs
string

Redirect URL for OAuth2.0 authorization_code and PKCE grant types

Example:

"https://app-host/auth"

​
UserID
integer

UID of a user to whom this application will belong

Example:

1

​
Visibility
enum<string>
default:organisation

Controls who can access this application. Options are: personal (visible only to you), team (shared with your team), and organisation (accessible to all members of your organisation).

Available options:
personal,
team,
organisation
Example:

"personal"

​
ID
integer

UID of this app

Example:

1

​
CreatedAt
string

Timestamp of when this application was created

Example:

"2023-06-25 13:37"

​
AccessRequests
object[][]