--- title: Read API Service Operation description: The GET {{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}} request returns data for the API service operation resource, identified by its ID in the request URL. component: pingone-api page_id: pingone-api:authorize:api-access-management/api-operations/read-api-server-operation canonical_url: https://developer.pingidentity.com/pingone-api/authorize/api-access-management/api-operations/read-api-server-operation.html section_ids: headers: Headers example-request: Example Request example-response: Example Response --- # Read API Service Operation ## ```none GET {{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes ``` The `GET {{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}` request returns data for the API service operation resource, identified by its ID in the request URL. This operation supports the use of the `expand` query parameter. If the service operation defines group, scope, or authentication policy requirements, the `expand` query parameter can be used to obtain information about the related resources. When used, additional data is included in the response's `_embedded` field. If the service operation defines application permission access requirements, a single HAL link labeled `permission` is included in the response's `_links` field. > **Collapse: Query parameters** > > | Query parameter | Description | Value | > | --------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | > | `expand` | Shows additional information from related resources in the response data. | \* `groups`\* `scopes`\* `authenticationPolicies`Multiple values can be separated by commas. For example, `expand=groups,scopes`. | ### Headers Authorization      Bearer {{accessToken}} ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups%2Cscopes' \ --header 'Authorization: Bearer {{accessToken}}' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Get); request.AddHeader("Authorization", "Bearer {{accessToken}}"); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups%2Cscopes" method := "GET" client := &http.Client { } req, err := http.NewRequest(method, url, nil) if err != nil { fmt.Println(err) return } req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http GET /v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes HTTP/1.1 Host: {{apiPath}} Authorization: Bearer {{accessToken}} ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = RequestBody.create(mediaType, ""); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes") .method("GET", body) .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes", "method": "GET", "timeout": 0, "headers": { "Authorization": "Bearer {{accessToken}}" }, }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'GET', 'url': '{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes', 'headers': { 'Authorization': 'Bearer {{accessToken}}' } }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests url = "{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes" payload = {} headers = { 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes'); $request->setMethod(HTTP_Request2::METHOD_GET); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Authorization' => 'Bearer {{accessToken}}' )); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups,scopes") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer {{accessToken}}" response = http.request(request) puts response.read_body ``` ```swift var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}?expand=groups%2Cscopes")!,timeoutInterval: Double.infinity) request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "GET" let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 200 OK ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/c43c112c-5835-457e-af92-f77aa192fabe/operations/40eed306-a15c-4c8f-9d5f-4ed2e5bd441d" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "apiServer": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/c43c112c-5835-457e-af92-f77aa192fabe" }, "permission": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationResources/c43c112c-5835-457e-af92-f77aa192fabe/permissions/0d2be05d-9ca4-4f98-8c0c-50af0ae5019d" } }, "_embedded": { "groups": [ { "_links": { "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/groups/66feb0da-1181-4d3c-af58-6ba8dac61706" } }, "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "id": "66feb0da-1181-4d3c-af58-6ba8dac61706" } ], "scopes": [ { "_links": { "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "resource": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/25169e5b-15a3-41be-b481-1f94779e1b35" }, "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/25169e5b-15a3-41be-b481-1f94779e1b35/scopes/814c9751-b8ca-4f05-b8f1-b820c11ab050" } }, "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "resource": { "id": "25169e5b-15a3-41be-b481-1f94779e1b35" }, "id": "814c9751-b8ca-4f05-b8f1-b820c11ab050" } ] }, "id": "40eed306-a15c-4c8f-9d5f-4ed2e5bd441d", "name": "Accounts", "methods": [ "POST", "PUT" ], "paths": [ { "type": "EXACT", "pattern": "/accounts" } ], "accessControl": { "group": { "groups": [ { "id": "66feb0da-1181-4d3c-af58-6ba8dac61706" } ] }, "scope": { "matchType": "ANY", "scopes": [ { "id": "814c9751-b8ca-4f05-b8f1-b820c11ab050" } ] }, "permission": { "id": "0d2be05d-9ca4-4f98-8c0c-50af0ae5019d" }, "authentication": { "acrs": [ { "id": "453cb9b6-b031-40a0-a7f0-408aee060f0f", "type": "PINGONE" } ], "maxAge": 600 } } } ```