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