...
| Name | Type | Description |
|---|---|---|
| name | string | Name of this API Profile |
| description | string | Description of this API Profile |
| roles | array of strings | If not empty, an API Designer needs one of these roles in order to be able to use the API Profile and select it for an API. |
| subscription.allow.override | boolean | |
| subscription.required | boolean | If true, a subscription is required in order to access this API, if false, no subscription is required and the API is accessible for everyone assuming no additional security has been configured for it. |
| subscriptionplans | array of strings | If subscription.required is set to true, this contains the list of IDs of the subscription plans that are applicable for this API - this list determines which plans an API Partner Application can subscribe to. |
| requestmod.specify.defaults | boolean | If true, request modification defaults are configured in the requestmodification object. See |
| requestmod.allow.override | boolean | If true, an API Designer is allowed to override requestmodification settings. |
| requestmod | JSON Object | See API Version requestmodification object. |
| security.specify.defaults | boolean | Set to true to specify security defaults for this API Profile |
| security.allow.override | boolean | If true, an API Designer is allowed to override security settings on an API Version |
| security.allow.override.per.operation | boolean | If true, an API Designer is allowed to specify security settings per operation |
| security | JSON Object | See API Version security object. |
| implementation.limit.methods | boolean | Set to true to limit implementation options that an API Designer can choose from. |
| implementation.method.pipeline | boolean | True to allow using Pipelines and Tasks as implementation method |
| implementation.method.script | boolean | True to allow using Scripts as implementation method |
| implementation.method.proxy | boolean | True to allow using Proxy as implementation method |
| implementation.allow.override.per.operation | boolean | If true, and API Designer can override implementation settings per operation -if false, he can only specify them for the entire API. |
| publish.allow | boolean | Set to true to allow an API Designer to publish APIs |
| environments | array of strings | List of environment names that an API can be published to. Leave empty for no restrictions |
| destinations | array of strings | List of destination names that proxying is restricted to. Leave empty for no restrictions |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id":"f83bb6fd-4252-4526-8bd0-49d973a41603",
"name":"MyMobileApplication",
"description":"The best of our applications",
"partner_id":"15ed2323-2913-4f09-b1c2-4694c7c50de5",
"client_id":"1a32f78d-83dc-488b-9e22-50b02e9328d1",
"client_secret":"f2add5d3-e67a-415f-8163-a751d7566047",
"apikeys": [
"1b119b37-e43b-46e3-9343-7cf26cec17ef"
],
"allowed_scopes": [
"openid","email","profile"
],
"valid_grant_types": [
"implicit","authorization_code","hybrid","client_credentials"
],
"developers": [
],
"accesstoken_type":"UUID",
"allowed_uris": [
"/redir1"
],
"allowed_logout_uris": [
"/logoff1"
],
"accesstoken_valid_seconds":60,
"refreshtoken_validity_seconds":60,
"maximum_idtoken_expiration_minutes":12,
"subscriptions": {
"c819724f-69e3-46bf-86d9-b15e59d1ffb0":"4841e9f5-2af5-4e42-ac1d-6b19be04c446"
},
"pending_subscriptions": [
{
"apiid": "73a02c77-c856-49fa-a1b0-be31ee8d808a",
"subscriptionplan_id": "4841e9f5-2af5-4e42-ac1d-6b19be04c446",
"comment_requestor": "Please grant me access",
"comment_response": "Certainly, enjoy",
"unread": false,
"action_id": "xxxxxx",
"approved": true,
"rejected": false
}
],
"certificates": [
{
"subject": "C=DKIO,OU=AssecoCeptor,CN=Person",
"issuer": "C=DKIO,OU=AssecoCeptor,CN=CA 1",
"certificate": "MIIDVDCCAjygAwIBAgIHA9bbH0Y2ADANxxxxxxx ..... ==",
"developer": null,
"certificate.allow.expired": false,
"certificate.skip.chain.checks": false
}
]
}
|
...