Loading

How To Approve/revoke Contracts Applied To An API Instance Using REST API

Publiseringsdato: Mar 2, 2024
Oppgave

GOAL

This article explains the steps to Approve/Revoke contracts applied to an API Instance using REST API. 

Trinn

Refer to the article "How To Retrieve Contract ID Applied To An API Instance" and follow the steps until Step 5 "Retrieve Contract ID"

Step 6:

a) Revoke Contract 


Execute the below API call.

curl --location --request PATCH 'https://anypoint.mulesoft.com/apimanager/api/v1/organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts/{contractId}' \
--header 'Authorization: Bearer AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"status": "REVOKED"
}'

Below is the output snippet from the above API call.

{"audit":{"created":{"date":"2022-01-07T13:34:33.588Z"},"updated":{"date":"2022-01-07T14:43:45.089Z"}},"masterOrganizationId":"{masterOrganizationId}}","organizationId":"{organizationId}}","id":2641059,"status":"REVOKED","approvedDate":"2022-01-07T14:43:20.181Z","rejectedDate":null,"revokedDate":"2022-01-07T14:43:45.089Z","applicationId":1188973,"application":{"audit":{"created":{"date":"2022-01-07T13:34:25.025Z"},"updated":{}},"masterOrganizationId":"{masterOrganizationId}}","id":1188973,"name":"Test_Contract","description":null,"clientProvider":{"providerId":null},"coreServicesId":"{coreServicesId}}","url":null,"grantTypes":[],"redirectUri":[],"clientId":"{clientId}}","clientSecret":"{clientSecret}}","owner":"{owner}}","email":"{email}}","owners":[{"id":"{id}}","createdAt":"2021-05-04T13:24:34.010Z","updatedAt":"2022-01-07T14:39:42.327Z","organizationId":"{organizationId}}","firstName":"{firstName}}","lastName":"{lastName}}","email":"{email}}","phoneNumber":"123456789","username":"{username}}","idprovider_id":"mulesoft","enabled":true,"deleted":false,"lastLogin":"2022-01-07T14:39:00.000Z","mfaVerificationExcluded":true,"mfaVerifiersConfigured":"false","isFederated":false,"roles":["{roles}}"],"type":"host"}]},"tierId":null,"tier":null,"requestedTierId":null,"requestedTier":null,"terms":null,"groupInstanceId":null,"groupInstance":null,"partyId":null,"partyName":null,"condition":"NOT_APPLIED","apiId":17010329,"api":{"audit":{"created":{},"updated":{}},"organizationId":"{organizationId}}","id":17010329}}

Note: Values in the above snippet output are masked. Use it as a reference only. 

Contract status in API Manager : 

User-added image

b) Approve Contract 

Execute the below API call.

curl --location --request PATCH 'https://anypoint.mulesoft.com/apimanager/api/v1/organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/contracts/{contractId}' \
--header 'Authorization: Bearer AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"status": "APPROVED", "condition": "ACTIVE"
}'
Below is the output snippet from the above API call.
{"audit":{"created":{"date":"2022-01-07T13:34:33.588Z"},"updated":{"date":"2022-01-07T14:57:15.409Z"}},"masterOrganizationId":"{masterOrganizationId}","organizationId":"{organizationId}","id":2641059,"status":"APPROVED","approvedDate":"2022-01-07T14:57:15.409Z","rejectedDate":null,"revokedDate":"2022-01-07T14:43:45.089Z","applicationId":1188973,"application":{"audit":{"created":{"date":"2022-01-07T13:34:25.025Z"},"updated":{}},"masterOrganizationId":"{masterOrganizationId}","id":1188973,"name":"Test_Contract","description":null,"clientProvider":{"providerId":null},"coreServicesId":"{coreServicesId}","url":null,"grantTypes":[],"redirectUri":[],"clientId":"{clientId}","clientSecret":"{clientSecret}","owner":"{owner}","email":"{email}","owners":[{"id":"{id}","createdAt":"2021-05-04T13:24:34.010Z","updatedAt":"2022-01-07T14:39:42.327Z","organizationId":"{organizationId}","firstName":"{firstName}","lastName":"{lastName}","email":"{email}","phoneNumber":"123456789","username":"{username}","idprovider_id":"mulesoft","enabled":true,"deleted":false,"lastLogin":"2022-01-07T14:39:00.000Z","mfaVerificationExcluded":true,"mfaVerifiersConfigured":"false","isFederated":false,"roles":["{roles}"],"type":"host"}]},"tierId":null,"tier":null,"requestedTierId":null,"requestedTier":null,"terms":null,"groupInstanceId":null,"groupInstance":null,"partyId":null,"partyName":null,"condition":"APPLIED","apiId":17010329,"api":{"audit":{"created":{},"updated":{}},"organizationId":"{organizationId}","id":17010329}}
Note: Values in the above snippet output are masked. Use it as a reference only. 

Contract status in API Manager : 

User-added image

ADDITIONAL DETAILS

1.  API Manager API: https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/api-manager-api/minor/1.0/pages/home/

2.  PATCH Endpoint: https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/api-manager-api/minor/1.0/console/method/%234193/
 


 



 

 



 

Knowledge-artikkelnummer

001115212

 
Laster
Salesforce Help | Article