--- title: Update External OAuth Server description: The PUT {{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}} updates the external OAuth server resource specified by its ID in the request URL. component: pingone-api page_id: pingone-api:authorize:api-access-management/external-oauth-servers/update-external-oauth-server canonical_url: https://developer.pingidentity.com/pingone-api/authorize/api-access-management/external-oauth-servers/update-external-oauth-server.html section_ids: prerequisites: Prerequisites headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Update External OAuth Server ## ```none PUT {{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}} ``` The `PUT {{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}` updates the external OAuth server resource specified by its ID in the request URL. When successful, a `200 OK` message and the requested external OAuth server resource is returned. ### Prerequisites * Refer to [PingOne Authorize API Access Management](../../api-access-management.html) for important overview information. > **Collapse: Request Model** > > For property descriptions, refer to [External OAuth server data model](../external-oauth-servers.html#external-oauth-server-data-model). > > | Property | Type | Required? | > | ------------------------------- | ------ | --------- | > | `description` | String | Optional | > | `issuers` | Array | Optional | > | `name` | String | Required | > | `type` | String | Required | > | `validation` | Object | Required | > | `validation.clockSkewTolerance` | Number | Optional | > | `validation.jwks` | String | Optional | > | `validation.jwksUrl` | String | Optional | > | `validation.type` | String | Required | ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff --request PUT '{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Put); request.AddHeader("Content-Type", "application/json"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); var body = @"{" + "\n" + @" ""name"": ""Example_2""," + "\n" + @" ""description"": ""OAuth server resource example""," + "\n" + @" ""type"": ""EXTERNAL""," + "\n" + @" ""issuers"": [" + "\n" + @" ""https://example.com/as""" + "\n" + @" ]," + "\n" + @" ""validation"": {" + "\n" + @" ""type"": ""JWKS_URL""," + "\n" + @" ""jwksUrl"": ""https://example.com/as/jwks""," + "\n" + @" ""clockSkewTolerance"": 5" + "\n" + @" }" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}" method := "PUT" payload := strings.NewReader(`{ "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/json") 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 PUT /v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}} HTTP/1.1 Host: {{apiPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"Example_2\",\n \"description\": \"OAuth server resource example\",\n \"type\": \"EXTERNAL\",\n \"issuers\": [\n \"https://example.com/as\"\n ],\n \"validation\": {\n \"type\": \"JWKS_URL\",\n \"jwksUrl\": \"https://example.com/as/jwks\",\n \"clockSkewTolerance\": 5\n }\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}") .method("PUT", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}", "method": "PUT", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'PUT', 'url': '{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}" payload = json.dumps({ "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("PUT", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}'); $request->setMethod(HTTP_Request2::METHOD_PUT); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/json', 'Authorization' => 'Bearer {{accessToken}}' )); $request->setBody('{\n "name": "Example_2",\n "description": "OAuth server resource example",\n "type": "EXTERNAL",\n "issuers": [\n "https://example.com/as"\n ],\n "validation": {\n "type": "JWKS_URL",\n "jwksUrl": "https://example.com/as/jwks",\n "clockSkewTolerance": 5\n }\n}'); 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 "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Put.new(url) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer {{accessToken}}" request.body = JSON.dump({ "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"name\": \"Example_2\",\n \"description\": \"OAuth server resource example\",\n \"type\": \"EXTERNAL\",\n \"issuers\": [\n \"https://example.com/as\"\n ],\n \"validation\": {\n \"type\": \"JWKS_URL\",\n \"jwksUrl\": \"https://example.com/as/jwks\",\n \"clockSkewTolerance\": 5\n }\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/externalOAuthServers/{{externalOAuthServerId}}")!,timeoutInterval: Double.infinity) request.addValue("application/json", forHTTPHeaderField: "Content-Type") request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "PUT" request.httpBody = postData 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/externalOAuthServers/60a1fc3b-d08a-4afb-819f-ad461f22cd13" }, "environment": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "apiServers": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers?filter=authorizationServer.externalOAuthServer.id%20eq%20%2260a1fc3b-d08a-4afb-819f-ad461f22cd13%22" } }, "id": "60a1fc3b-d08a-4afb-819f-ad461f22cd13", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "name": "Example_2", "description": "OAuth server resource example", "type": "EXTERNAL", "issuers": [ "https://example.com/as" ], "validation": { "type": "JWKS_URL", "jwksUrl": "https://example.com/as/jwks", "clockSkewTolerance": 5 } } ```