Ana içeriğe atla

​
Endpoint

GET /apiops/reports/organization-api-data-model-access

​
Authentication

Requires a Personal API Access Token with admin or analyzer privileges. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

None.

​
Query Parameters

None.

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "result": {
    "apiProxyList": [
      {
        "apiProxyName": "MyAPI",
        "sharingType": "EXTERNAL",
        "accessList": []
      }
    ],
    "dataModelList": []
  }
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
resultobjectReport result. See Report Result Object

​
Report Result Object (result)

FieldTypeDescription
apiProxyListarray[object]List of API Proxy access information
dataModelListarray[object]List of data model access information

​
API Proxy Access Object (apiProxyList item)

FieldTypeDescription
apiProxyNamestringAPI Proxy name
sharingTypestringSharing type. See EnumSharingType
accessListarray[object]List of access information

​
EnumSharingType (sharingType)

  • EXTERNAL - Shared externally
  • INTERNAL - Shared internally only
  • BOTH - Shared both internally and externally
  • NONE - Not shared

​
Notes

  • Report includes only APIs with EXTERNAL or BOTH sharing types
  • Empty lists are returned if no data matches the criteria
  • Only accessible by sysAdmin or sysAnalyzer users

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Unauthorized API Access!"
}

​
cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/reports/organization-api-data-model-access" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Permissions

  • User must have system admin (sysAdmin) or system analyzer (sysAnalyzer) role

​
Notes and Warnings

  • Admin/Analyzer Only:
    • This endpoint requires sysAdmin or sysAnalyzer privileges
    • Regular users cannot access this endpoint
  • Sharing Types:
    • Report includes only APIs with EXTERNAL or BOTH sharing types
    • Internal-only APIs are excluded