Skip to main content

Access Control (REST) API - Service Provider

This section includes REST APIs for working with Access Control Service Provider tasks.

Get All Service Providers - GET /ServiceProviders (v2.0 and up)

Get a list of all the service providers.

Notice

The ‘Manage Roles’ or ‘Manage Users’ permission is required to execute this API.

Usage:

GET /ServiceProviders and get a list of all the service providers

URL

/cxrestapi/auth/ServiceProviders

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>

Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized

Code: 403 Forbidden

Sample Response:

[
 {
    "id": 1,
    "name": "access-control"
  },
  {
    "id": 2,
    "name": "sast"
  },
  {
    "id": 3,
    "name": "management-and-orchestration"
  }
]

Notes:

Retrieves details of all service providers. If the request fails, it returns an error response.

Get Service Provider by Id - GET /ServiceProviders/{id} (v2.0 and up)

Get details of service provider according to Service Provider Id.

Notice

The ‘Manage Roles’ or ‘Manage Users’ permission is required to execute this API.

Usage:

GET /ServiceProviders/{id} and get details of service provider

URL

/cxrestapi/auth/ServiceProvider/{id}

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>

Accept: application/json;v=1.0

Parameters

id=[integer] - Unique Id of the service provider

Success Response:

Code: 200 Success

Error Response:

Code: 400 Bad Request

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found

Sample Response:

{
  "id": 3,
  "name": "management-and-orchestration"
}

Notes:

Retrieves service provider details according to the specified service provider Id. If the request fails, it returns an error response.

In this section: