{"items":[{"type":"link","label":"CCM User Subscription Service","link":"/solutions/ccm/apis/ccm-user-subscription-service","routeSlug":"/solutions/ccm/apis/ccm-user-subscription-service","content":{"contentType":"overview","meta":{"name":"CCM User Subscription Service"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"CCM-User-Subscription-Service.json","url":"/_bundle/solutions/ccm/apis/CCM-User-Subscription-Service.json?download"},{"kind":"download","label":"CCM-User-Subscription-Service.yaml","url":"/_bundle/solutions/ccm/apis/CCM-User-Subscription-Service.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.delfi.slb.com/ccm/userSubscription","description":"US"},{"url":"https://eu-api.delfi.slb.com/ccm/userSubscription","description":"EU"},{"url":"/_mock/solutions/ccm/apis/ccm-user-subscription-service","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"CCM User Subscription Service (1.0.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cloud Core Management Services: User Subscription Service"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs that support Access Token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/v2/userSubscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":""},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No whitelisting required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"76605fa451c74e4ab43ac66411c08f05\n","language":"plain","title":"ClientID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"76605fa451c74e4ab43ac66411c08f05\n"},"children":[]}]}]}],"sectionId":"/solutions/ccm/apis/ccm-user-subscription-service"}],"sectionId":"/solutions/ccm/apis/ccm-user-subscription-service"}]}]}},{"type":"group","label":"user-subscription-service-v2","link":"/solutions/ccm/apis/ccm-user-subscription-service/user-subscription-service-v2","routeSlug":"/solutions/ccm/apis/ccm-user-subscription-service/user-subscription-service-v2","items":[{"label":"Get the user's active subscriptions.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/ccm/apis/ccm-user-subscription-service/user-subscription-service-v2/getusersubscriptionswithterms","routeSlug":"/solutions/ccm/apis/ccm-user-subscription-service/user-subscription-service-v2/getusersubscriptionswithterms","metadata":{"seo":{"title":"Get the user's active subscriptions.","description":"The API returns active subscriptions associated with the user specified in the provided user token, given that the user has accepted the latest SLB Digital T&Cs.At least one of groupId, appCode or billingAccountId is required.If query parameters are specified, then the results are filtered using an AND operation.The user is identified through their user-principal, as indicated by the email claim in the JWT token within the authorization header.The API caller is authenticated via the service principal, as indicated by the azp (Authorized Party) claim in the JWT token within the authorization header.If your application must be scoped to specific billing accounts, the client ID needs the ccm.subscription.read (e.g., the controlPlaneAdmin role) permission. Please raise the request with the CSI team.The API enforces a request rate limit of 10 requests per minute per caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserSubscriptionsWithTerms","name":"Get the user's active subscriptions.","isWebhook":false,"pointer":"/paths/~1v2~1userSubscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the user's active subscriptions.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API returns active subscriptions associated with the user specified in the provided user token, given that the user has accepted the latest SLB Digital T&Cs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one of groupId, appCode or billingAccountId is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If query parameters are specified, then the results are filtered using an AND operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user is identified through their user-principal, as indicated by the email claim in the JWT token within the authorization header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API caller is authenticated via the service principal, as indicated by the azp (Authorized Party) claim in the JWT token within the authorization header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your application must be scoped to specific billing accounts, the client ID needs the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ccm.subscription.read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., the controlPlaneAdmin role) permission. Please raise the request with the CSI team."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API enforces a request rate limit of 10 requests per minute per caller."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey","description":"AppKey/ConsumerKey from your App on Developer Portal"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appCode","in":"query","schemaId":"schema_392","description":"A unique identifier of an application as defined in the catalog.","example":"apideveloperportal"},{"name":"groupId","in":"query","schemaId":"schema_392","description":"A unique identifier to specify the application's group as defined in the catalog.","example":"Cirrus"},{"name":"billingAccountId","in":"query","schemaId":"schema_392","description":"ID of the billing account representing client's legal entity with which a contract was signed.","example":"DIGITAL2020"}],"pointer":"/paths/~1v2~1userSubscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/userSubscriptions","servers":[{"url":"https://api.delfi.slb.com/ccm/userSubscription","description":"US"},{"url":"https://eu-api.delfi.slb.com/ccm/userSubscription","description":"EU"},{"url":"/_mock/solutions/ccm/apis/ccm-user-subscription-service","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"appCode","in":"query","example":"apideveloperportal","schemaId":"schema_392"},{"name":"groupId","in":"query","example":"Cirrus","schemaId":"schema_392"},{"name":"billingAccountId","in":"query","example":"DIGITAL2020","schemaId":"schema_392"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404","429","500","503"],"pointer":"/v2/userSubscriptions","href":"user-subscription-service-v2/getusersubscriptionswithterms","openApiOperationId":"GetUserSubscriptionsWithTerms","summary":"Get the user's active subscriptions."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/ccm/userSubscription","description":"US"},{"url":"https://eu-api.delfi.slb.com/ccm/userSubscription","description":"EU"},{"url":"/_mock/solutions/ccm/apis/ccm-user-subscription-service","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsResponse"}},"schemaId":"components/schemas/SubscriptionsResponse"},{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"},{"code":"503","description":"Service Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}},"schemaId":"components/schemas/SimpleResponse"}],"pointer":"/paths/~1v2~1userSubscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionsResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}},{"code":"401","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}},{"code":"403","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}},{"code":"404","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}},{"code":"429","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}},{"code":"500","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}},{"code":"503","schemaId":"components/schemas/SimpleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user-subscription-service-v2/getusersubscriptionswithterms"}],"panels":[]}]},"httpPath":"/v2/userSubscriptions"}],"content":{"contentType":"group","meta":{"name":"user-subscription-service-v2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"user-subscription-service-v2","showPageActions":true},{"nodeType":"markdoc","content":"Query user subscription information. In v2, user subscriptions are contingent upon user accepting latest terms and conditions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/userSubscriptions","summary":"Get the user's active subscriptions.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-subscription-service-v2/getusersubscriptionswithterms","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SubscriptionsResponse":{"id":"components/schemas/SubscriptionsResponse","kind":"json-schema","title":"SubscriptionsResponse","data":{"type":"object","properties":{"hasAcceptedTerms":{"type":"boolean","description":"True if user has accepted latest terms and conditions"},"userSubscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Response"}}},"description":"response for user subscriptions that includes indicator whether latest terms and conditions were accepted"}},"components/schemas/Response":{"id":"components/schemas/Response","kind":"json-schema","title":"Response","data":{"type":"object","properties":{"contractId":{"type":"string","description":"ContractId is the CRM ID for the Contract, with which user's subscription was approved"},"billingAccountId":{"type":"string","description":"billingAccountId is the CRM ID for the Billing Account"},"billingAccountName":{"type":"string","description":"Billing account name"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Subscriptions"}}},"description":"response for user subscription"}},"components/schemas/Subscriptions":{"id":"components/schemas/Subscriptions","kind":"json-schema","title":"Subscriptions","data":{"type":"object","properties":{"departmentId":{"type":"string","description":"departmentId is the CCM Auto-Generated ID for the Department"},"departmentName":{"type":"string","description":"department name"},"subscriptionId":{"type":"string","description":"subscriptionId is the CCM Auto-Generated ID for the Subscription"},"region":{"type":"string","description":"Region of the endpoint registered in Delfi"},"endpointID":{"type":"string","description":"A unique id issued for the endpoint (instance) registered in Delfi"},"endpointLabel":{"type":"string","description":"Name/Label registered for the endpointID"},"instance":{"type":"string","description":"URL of the endpoint registered in Delfi"},"userId":{"type":"string","description":"userId is the user email retrieved from user token"},"durationId":{"type":"string","description":"Commitment duration selected in Delfi Portal at the time of approving a subscription request"},"createdAt":{"type":"string","format":"date-time","description":"Time at which subscription got created"},"createdBy":{"type":"string","description":"userID of caller","example":"abc@slb.com"},"deletedAt":{"type":"string","format":"date-time","x-nullable":true,"description":"Time at which subscription got deleted. It will be empty for active subscriptions"},"anniversaryDate":{"type":"string","format":"date-time","description":"A monthly anniversary date of a subscription based on the creation date"},"isConsultantMode":{"type":"boolean","x-nullable":true,"description":"Subscriptions requested by SLB users in this mode are not charged to the contract"},"icon":{"type":"string","description":"An icon representing the product.","example":"https://api.evd.csp.slb.com/ccm/catalog/v1/icons/EISJ-IS-UTL"},"deletedBy":{"type":"string","description":"userID of person deleting the susbcription.","example":"abc@slb.com"},"product":{"$ref":"#/components/schemas/Product"}},"description":"user subscription"}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","properties":{"description":{"type":"string","description":"Description of the Product"},"partNumber":{"type":"string","description":"Unique id of the product"},"name":{"type":"string","description":"Name of the product"},"code":{"type":"string","description":"Code assigned for Product"},"groupId":{"type":"string","description":"Product group id"},"featureSets":{"type":"array","items":{"$ref":"#/components/schemas/FeatureSets"},"x-omitempty":true},"productType":{"type":"string","description":"Type of Product (e.g. Domain profile, Plugin etc.)"}},"description":"Details of the product associated with the subscription"}},"components/schemas/FeatureSets":{"id":"components/schemas/FeatureSets","kind":"json-schema","title":"FeatureSets","data":{"type":"object","description":"Feature claims grouped together as per product/business requirements","properties":{"applicationName":{"type":"string","description":"Name of application whose access is granted by product subscription"},"applicationCode":{"type":"string","description":"Unique application code"},"name":{"type":"string","description":"Name of feature set grouping feature claims of an application"},"type":{"type":"string","description":"Type of feature set e.g. Base, Add-On"},"claims":{"type":"array","description":"Feature claims representing access to various workflows within an application","items":{"type":"string"},"x-omitempty":true}}}},"components/schemas/SimpleResponse":{"id":"components/schemas/SimpleResponse","kind":"json-schema","title":"SimpleResponse","data":{"type":"object","properties":{"message":{"type":"string"}}}},"schema_392":{"kind":"json-schema","data":{"type":"string"},"id":"schema_392"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User Token from SLB Authenticator Service"},"appkey":{"id":"appkey","type":"apiKey","description":"AppKey/ConsumerKey from your App on Developer Portal","in":"header","paramName":"appkey"}},"servers":[{"url":"https://api.delfi.slb.com/ccm/userSubscription","description":"US"},{"url":"https://eu-api.delfi.slb.com/ccm/userSubscription","description":"EU"},{"url":"/_mock/solutions/ccm/apis/ccm-user-subscription-service","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/solutions/ccm/apis/ccm-user-subscription-service","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/solutions/ccm/apis/CCM-User-Subscription-Service.json?download"},{"url":"/_bundle/solutions/ccm/apis/CCM-User-Subscription-Service.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"CCM User Subscription Service","description":"Cloud Core Management Services: User Subscription Service  \nAPIs that support Access Token:\n  - /v2/userSubscriptions \n\n\n{% admonition type=\"info\" name=\"\" %}\n  No whitelisting required.\n{% /admonition %}\n\n```plain {% title=\"ClientID\" %}\n76605fa451c74e4ab43ac66411c08f05\n```    \n"}},"baseSlug":"/solutions/ccm/apis/ccm-user-subscription-service","routesMapping":{}}