User API

Use this API to get information related to users.

Base URL

https://<host>:<port>/csa/rest

URIs

The following URIs are appended to the base URL:

Request

A request is created whenever a user initiates, changes, or deletes a subscription.

URI Method Parameters Description
/user/instance/<instance_id>/request GET userIdentifier List service requests for subscription
/user/myrequest GET userIdentifier, scope, detail, submitter, returnRetired, submitStartDate, submitEndDate List active requests for user
/user/request/count GET userIdentifier Get count of requests for user
/user/multipleRequest/cancel POST userIdentifier Cancel multiple service requests
/user/multipleRequest/delete POST userIdentifier Delete multiple service requests

Approval

An approval is created when the approval manager approves a request.

URI Method Parameters Description
/user/approval/count GET userIdentifier Get count of approvals for user
/user/multipleApprovals/delete POST userIdentifier Delete multiple approval requests
/user/myapproval GET userIdentifier, scope, detail, returnRetired, approver, creationStartDate, CreationEndDate List approvals for approver

Subscription

A subscription is created when a consumer requests a service offering and includes all of the options selected by the consumer when the subscription was initiated.

URI Method Parameters Description
/user/mysubscription GET userIdentifier, scope, detail, requestor, returnRetired, creationStartDate, creationEndDate, modificationStartDate, modificationEndDate List subscriptions for user
/user/subscription/count GET userIdentifier Get count of subscriptions for user
/user/subscription GET userIdentifier, queryType Get list of recent or expiring soon subscriptions for user
/user/multipleSubscription/delete POST userIdentifier Delete multiple subscriptions

Instance

An instance is created when a request is approved and includes details about the requested services such as the status of services, IP addresses, etc.

URI Method Parameters Description
/user/myinstance GET userIdentifier, scope, detail, requestor, returnRetired, creationStartDate, creationEndDate List instances for user