...
| 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,
"confidential": false,
"refreshtoken_invalidate_on_use": false,
"refreshtoken_issue_new_on_use": false,
"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=IO,OU=Ceptor,CN=Person",
"issuer": "C=IO,OU=Ceptor,CN=CA 1",
"certificate": "MIIDVDCCAjygAwIBAgIHA9bbH0Y2ADANxxxxxxx ..... ==",
"developer": null,
"certificate.allow.expired": false,
"certificate.skip.chain.checks": false
}
]
}
|
...
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID of this application. |
| name | string | Name of this API Partner application |
| description | string | Description of the API Partner application |
| partner_id | string | Unique ID of the application this partner is linked to |
| client_id | string | The client ID that can authenticate this application |
| client_secret | string | The secret for the provided client id mentioned above |
| confidential | boolean | If true, client is confidential and client_secret must always be used |
| refreshtoken_invalidate_on_use | boolean | If true, a refresh_token is invalidated when used, meaning it can be used only a single time |
| refreshtoken_issue_new_on_use | boolean | If true, a new refresh_token is issued when the old one is used |
apikeys | array of strings | List of API keys that can be used to authenticate this application if allowed |
| allowed_scopes | array of strings | Specifies which scopes the application is allowed to request. |
valid_grant_types | array of strings | The allowed grant types that this application is allowed to use |
accesstoken_type | string | The type of OAuth2 access token can be either UUID, or JWT - if it is a UUID, it can be used as a key - e.g. a bearer token, which is presented during authentication. If JWT, the access token is a signed JWT (JSON Web Token) containing information about the user |
allowed_uris | array of strings | OAuth2 redirect URIs for the application |
allowed_logout_uris | array of strings | OAuth2 Logout URIs which are allowed for this application |
accesstoken_valid_seconds | number | If set, overrides the time an issued OAuth2 access token is valid for |
refreshtoken_validity_seconds | number | If set, this is the number of seconds that an OAuth2 access token is valid for. |
maximum_idtoken_expiration_minutes | number | If set, this is the number of minutes that an issued ID token is valid for |
subscriptions | array of JSON objects | List of JSON Objects with API unique ID as key and subscription plan unique ID as value. |
| developers | array of JSON Objects | List of JSON objects with developers |
| string | The UID of the developer |
| string | The developer role for this application (OWNER, DEVELOPER, READ_ONLY) |
| certificates | array of JSON Objects | List of JSON objects with SSL/TLS client certificate information |
| string | Certificate Subject DN |
| string | Certificate Issuer DN |
| string | certificate, DER encoded and base64 encoded. Subject and Issuer MUST match the certificate. |
| string | ID of developer who added the certificate in developer portal, if any. |
| boolean | True if expired certificate is allowed |
| boolean | True if certificate chain, revocation etc. check should be skipped and request trusted if client cert matches this cert. |
pending_subscriptions | array of JSON objects | List of JSON objects with pending subscription requests |
| string | API ID |
| string | Subscription Plan ID |
| string | Comment made by the requestor when requesting the subscription |
| string | Comment made by the approver/rejector |
| boolean | True if unread by API Partner |
| string | ID of corresponding Action created for this request |
| boolean | True, if request has been approved by administrator |
| boolean | True, if request has been rejected by administrator |
...