Get app configuration details

1min
GET
https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/apps
Get the app configuration.
Permissions:Permissions are the access rights needed to control who can do what within the app. This list specifies the permissions required to access particular resources.
For instance, if your app exposes User-related events and provides an API for fetching user details at '/api/v1/users/
', the permissions necessary to access this endpoint should be added here. You can find them in your app's AAA YAML.
Subscribers who want to receive events from this app must have at least one of the role that includes these listed permissions. This will be used to control only authorized apps are able to subscribe to your events.
Name:User friendly name for the app, subscribers will use this name to subscribe to the app's published events.
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-AUTH
string
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
*
Query Parameters
nextPage
string
limit
integer
Responses
200
OK - The request succeeded.
AppConfigResponsePaginated
data
object
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
request
Request
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/apps?limit=20' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubdomain}.getos1.com/core/api/v1/webhooks/apps?limit=20' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
403
404
503
// OK - The request succeeded. 
{
  "data": {
    "meta": {
      "nextPage": "",
      "hasNextPage": false
    },
    "apps": [
      {
        "appId": "",
        "permissions": [
          ""
        ],
        "name": ""
      }
    ]
  }
}
// OK - The request succeeded. 
{
  "data": {
    "meta": {
      "nextPage": "",
      "hasNextPage": false
    },
    "apps": [
      {
        "appId": "",
        "permissions": [
          ""
        ],
        "name": ""
      }
    ]
  }
}
﻿
﻿
Updated 07 Feb 2024
Did this page help you?
Create app configuration
Update app configuration