{"type":"api","title":"Update the client certificate authentication configuration","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/5e144619-25b2-30e4-9a1e-a368d8dadee6","info":{"title":"Crosswork Remote Authentication Server Integration API - Version 1","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0","description":"APIs to support integration of the Crosswork platform and remote authentication servers. TACACS+, LDAP, RADIUS, SSO server types are supported."},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/RBAC/auth-remote-v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/authconfig/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Use a bearer token to authenticate requests. Include the token in the Authorization header with the prefix 'Bearer '."}}},"spec":{"summary":"Update the client certificate authentication configuration","description":"Update the client certificate authentication configuration in Crosswork.","operationId":"UpdateClientAuthConfig","consumes":["application/json"],"produces":["application/json"],"responses":{"204":{"description":"No Content. The request was successful and there is no additional content in the response body.","schema":{"type":"object","properties":{"example":{"type":"array"}},"example":{"name":{"type":"string","description":"No Content"}},"$$ref":"#/definitions/authconfigEmpty"}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"422":{"description":"Unprocessable Entity. The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions."},"500":{"description":"Internal Server Error. The server could not fulfill the request."}},"parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"object","required":["client_auth","use_custom_oid","custom_oid_type","custom_oid_reg_expr","ocsp_required","use_custom_ocsp","ocsp_url1","ocsp_url2"],"properties":{"client_auth":{"type":"boolean","description":"Enables the client certificate authentication"},"use_custom_oid":{"type":"boolean","description":"If enabled, will use the custom OID params for identifying the User Identity Source"},"custom_oid_type":{"type":"string","description":"Defines how to extract the user identity from a client certificate"},"custom_oid_reg_expr":{"type":"string","description":"Single group regular expression to be used as a filter while extracting certificate identity"},"ocsp_required":{"type":"boolean","description":"Enables whether to check the certificate revocation status using online certificate status protocol or not"},"use_custom_ocsp":{"type":"boolean","description":"If enabled, will use the provided oscp_url configuration, else will retrieve from the certificate"},"ocsp_url1":{"type":"string","description":"OSCP server URL for performing validation"},"ocsp_url2":{"type":"string","description":"Optional OSCP server URL for performing validation when ocsp_url1 is not reachable"}},"example":{"client_auth":true,"use_custom_oid":true,"custom_oid_type":"SubjectDN","custom_oid_reg_expr":"CN=(.*?),","ocsp_required":true,"use_custom_ocsp":false,"ocsp_url1":"","ocsp_url2":""},"$$ref":"#/definitions/clientauthconfig"},"description":"application/json"}],"tags":["clientauthconfig"],"__originalOperationId":"UpdateClientAuthConfig","security":[{"bearerAuth":[]}],"method":"put","path":"/clientauth"}}