text: (window.webpackJsonp=window.webpackJsonp||[]).push([[34],{168:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){return r})),a.d(t,"metadata",(function(){return c})),a.d(t,"rightToc",(function(){return s})),a.d(t,"default",(function(){return i}));var n=a(2),b=a(9),l=(a(0),a(174)),r={title:"ORY Keto",language_tabs:[],toc_footers:[],includes:[],search:!1,highlight_theme:"darkula",headingLevel:2},c={id:"reference/api",title:"ORY Keto",description:"Ory Keto is a cloud native access control server providing best-practice patterns (RBAC, ABAC, ACL, AWS IAM Policies, Kubernetes Roles, ...) via REST APIs.",source:"@site/docs/reference/api.mdx",permalink:"/keto/docs/next/reference/api",editUrl:"https://github.com/ory/keto/edit/master/docs/docs/reference/api.mdx",version:"next",sidebar:"docs",previous:{title:"Configuration",permalink:"/keto/docs/next/reference/configuration"},next:{title:"Overview",permalink:"/keto/docs/next/sdk/index"}},s=[{value:"Check if a request is allowed",id:"check-if-a-request-is-allowed",children:[]},{value:"listOryAccessControlPolicies",id:"listoryaccesscontrolpolicies",children:[]},{value:"upsertOryAccessControlPolicy",id:"upsertoryaccesscontrolpolicy",children:[]},{value:"getOryAccessControlPolicy",id:"getoryaccesscontrolpolicy",children:[]},{value:"deleteOryAccessControlPolicy",id:"deleteoryaccesscontrolpolicy",children:[]},{value:"List ORY Access Control Policy Roles",id:"list-ory-access-control-policy-roles",children:[]},{value:"Upsert an ORY Access Control Policy Role",id:"upsert-an-ory-access-control-policy-role",children:[]},{value:"Get an ORY Access Control Policy Role",id:"get-an-ory-access-control-policy-role",children:[]},{value:"Delete an ORY Access Control Policy Role",id:"delete-an-ory-access-control-policy-role",children:[]},{value:"Add a member to an ORY Access Control Policy Role",id:"add-a-member-to-an-ory-access-control-policy-role",children:[]},{value:"Remove a member from an ORY Access Control Policy Role",id:"remove-a-member-from-an-ory-access-control-policy-role",children:[]},{value:"Check alive status",id:"check-alive-status",children:[]},{value:"Check readiness status",id:"check-readiness-status",children:[]},{value:"Get service version",id:"get-service-version",children:[]},{value:"Schemas",id:"schemas",children:[]}],o={rightToc:s};function i(e){var t=e.components,a=Object(b.a)(e,["components"]);return Object(l.b)("wrapper",Object(n.a)({},o,a,{components:t,mdxType:"MDXLayout"}),Object(l.b)("p",null,"Ory Keto is a cloud native access control server providing best-practice patterns (RBAC, ABAC, ACL, AWS IAM Policies, Kubernetes Roles, ...) via REST APIs."),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which\nitself is generated from annotations in the source code of the project. It is possible that this documentation includes\nbugs and that code samples are incomplete or wrong."),Object(l.b)("p",{parentName:"blockquote"},"If you find issues in the respective documentation, please do not edit the\nMarkdown files directly (as they are generated) but raise an issue on the project's GitHub presence instead. This documentation\nwill improve over time with your help! If you have ideas how to improve this part of the documentation, feel free to\nshare them in a ",Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"https://github.com/ory/docs/issues/new"}),"GitHub issue")," any time.")),Object(l.b)("a",{id:"ory-keto-engines"}),"## engines",Object(l.b)("a",{id:"opIddoOryAccessControlPoliciesAllow"}),Object(l.b)("h3",{id:"check-if-a-request-is-allowed"},"Check if a request is allowed"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"POST /engines/acp/ory/{flavor}/allowed HTTP/1.1\nContent-Type: application/json\nAccept: application/json\n\n")),Object(l.b)("p",null,"Use this endpoint to check if a request is allowed or not. If the request is allowed, a 200 response with\n",Object(l.b)("inlineCode",{parentName:"p"},'{"allowed":"true"}')," will be sent. If the request is denied, a 403 response with ",Object(l.b)("inlineCode",{parentName:"p"},'{"allowed":"false"}')," will\nbe sent instead."),Object(l.b)("h4",{id:"request-body"},"Request body"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "action": "string",\n  "context": {},\n  "resource": "string",\n  "subject": "string"\n}\n')),Object(l.b)("a",{id:"check-if-a-request-is-allowed-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicyallowedinput"}),"oryAccessControlPolicyAllowedInput")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h4",{id:"responses"},"Responses"),Object(l.b)("a",{id:"check-if-a-request-is-allowed-responses"}),Object(l.b)("h5",{id:"overview"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"authorizationResult"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaauthorizationresult"}),"authorizationResult"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"403"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.5.3"}),"Forbidden")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"authorizationResult"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaauthorizationresult"}),"authorizationResult"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"check-if-a-request-is-allowed-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "allowed": true\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-doOryAccessControlPoliciesAllow"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-doOryAccessControlPoliciesAllow-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-doOryAccessControlPoliciesAllow-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-doOryAccessControlPoliciesAllow-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-doOryAccessControlPoliciesAllow-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-doOryAccessControlPoliciesAllow-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-doOryAccessControlPoliciesAllow-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-doOryAccessControlPoliciesAllow-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X POST /engines/acp/ory/{flavor}/allowed \\\n  -H 'Content-Type: application/json' \\  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-doOryAccessControlPoliciesAllow-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Content-Type": []string{"application/json"},\n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("POST", "/engines/acp/ory/{flavor}/allowed", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-doOryAccessControlPoliciesAllow-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\nconst input = '{\n  \"action\": \"string\",\n  \"context\": {},\n  \"resource\": \"string\",\n  \"subject\": \"string\"\n}';\nconst headers = {\n  'Content-Type': 'application/json',  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/allowed', {\n  method: 'POST',\n  body: input,\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-doOryAccessControlPoliciesAllow-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/allowed");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("POST");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-doOryAccessControlPoliciesAllow-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Content-Type': 'application/json',\n  'Accept': 'application/json'\n}\n\nr = requests.post(\n  '/engines/acp/ory/{flavor}/allowed',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-doOryAccessControlPoliciesAllow-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Content-Type' => 'application/json',\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.post '/engines/acp/ory/{flavor}/allowed',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdlistOryAccessControlPolicies"}),Object(l.b)("h3",{id:"listoryaccesscontrolpolicies"},"listOryAccessControlPolicies"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /engines/acp/ory/{flavor}/policies HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"List ORY Access Control Policies"),Object(l.b)("a",{id:"listoryaccesscontrolpolicies-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact"')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"limit"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The maximum amount of policies returned.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"offset"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The offset from where to start looking.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"subject"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The subject for whom the policies are to be listed.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"resource"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The resource for which the policies are to be listed.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"action"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The action for which policies are to be listed.")))),Object(l.b)("h4",{id:"responses-1"},"Responses"),Object(l.b)("a",{id:"listoryaccesscontrolpolicies-responses"}),Object(l.b)("h5",{id:"overview-1"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Policies is an array of policies."),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"listoryaccesscontrolpolicies-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"200")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("em",{parentName:"td"},"anonymous")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[",Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicy"}),"oryAccessControlPolicy"),"]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb oryAccessControlPolicy specifies an ORY Access Policy document."),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicy"}),"oryAccessControlPolicy")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb actions"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Actions is an array representing all the actions this ORY Access Policy applies to.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb conditions"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"object"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Conditions represents a keyed object of conditions under which this ORY Access Policy is active.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb description"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Description is an optional, human-readable description.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb effect"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'Effect is the effect of this ORY Access Policy. It can be "allow" or "deny".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb resources"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Resources is an array representing all the resources this ORY Access Policy applies to.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb\xbb subjects"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Subjects is an array representing all the subjects this ORY Access Policy applies to.")))),Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-1"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'[\n  {\n    "actions": [\n      "string"\n    ],\n    "conditions": {},\n    "description": "string",\n    "effect": "string",\n    "id": "string",\n    "resources": [\n      "string"\n    ],\n    "subjects": [\n      "string"\n    ]\n  }\n]\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-1"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-listOryAccessControlPolicies"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-listOryAccessControlPolicies-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicies-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicies-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicies-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicies-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicies-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-listOryAccessControlPolicies-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /engines/acp/ory/{flavor}/policies \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicies-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/engines/acp/ory/{flavor}/policies", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicies-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/policies', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicies-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/policies");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicies-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/engines/acp/ory/{flavor}/policies',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicies-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/engines/acp/ory/{flavor}/policies',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdupsertOryAccessControlPolicy"}),Object(l.b)("h3",{id:"upsertoryaccesscontrolpolicy"},"upsertOryAccessControlPolicy"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"PUT /engines/acp/ory/{flavor}/policies HTTP/1.1\nContent-Type: application/json\nAccept: application/json\n\n")),Object(l.b)("p",null,"Upsert an ORY Access Control Policy"),Object(l.b)("h4",{id:"request-body-1"},"Request body"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "actions": [\n    "string"\n  ],\n  "conditions": {},\n  "description": "string",\n  "effect": "string",\n  "id": "string",\n  "resources": [\n    "string"\n  ],\n  "subjects": [\n    "string"\n  ]\n}\n')),Object(l.b)("a",{id:"upsertoryaccesscontrolpolicy-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicy"}),"oryAccessControlPolicy")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h4",{id:"responses-2"},"Responses"),Object(l.b)("a",{id:"upsertoryaccesscontrolpolicy-responses"}),Object(l.b)("h5",{id:"overview-2"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"oryAccessControlPolicy"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicy"}),"oryAccessControlPolicy"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"upsertoryaccesscontrolpolicy-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-2"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "actions": [\n    "string"\n  ],\n  "conditions": {},\n  "description": "string",\n  "effect": "string",\n  "id": "string",\n  "resources": [\n    "string"\n  ],\n  "subjects": [\n    "string"\n  ]\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-2"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-upsertOryAccessControlPolicy"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-upsertOryAccessControlPolicy-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicy-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicy-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicy-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicy-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicy-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-upsertOryAccessControlPolicy-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X PUT /engines/acp/ory/{flavor}/policies \\\n  -H 'Content-Type: application/json' \\  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicy-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Content-Type": []string{"application/json"},\n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("PUT", "/engines/acp/ory/{flavor}/policies", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicy-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),'const fetch = require(\'node-fetch\');\nconst input = \'{\n  "actions": [\n    "string"\n  ],\n  "conditions": {},\n  "description": "string",\n  "effect": "string",\n  "id": "string",\n  "resources": [\n    "string"\n  ],\n  "subjects": [\n    "string"\n  ]\n}\';\nconst headers = {\n  \'Content-Type\': \'application/json\',  \'Accept\': \'application/json\'\n}\n\nfetch(\'/engines/acp/ory/{flavor}/policies\', {\n  method: \'PUT\',\n  body: input,\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicy-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/policies");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("PUT");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicy-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Content-Type': 'application/json',\n  'Accept': 'application/json'\n}\n\nr = requests.put(\n  '/engines/acp/ory/{flavor}/policies',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicy-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Content-Type' => 'application/json',\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.put '/engines/acp/ory/{flavor}/policies',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdgetOryAccessControlPolicy"}),Object(l.b)("h3",{id:"getoryaccesscontrolpolicy"},"getOryAccessControlPolicy"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /engines/acp/ory/{flavor}/policies/{id} HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"Get an ORY Access Control Policy"),Object(l.b)("a",{id:"getoryaccesscontrolpolicy-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The ID of the ORY Access Control Policy Role.")))),Object(l.b)("h4",{id:"responses-3"},"Responses"),Object(l.b)("a",{id:"getoryaccesscontrolpolicy-responses"}),Object(l.b)("h5",{id:"overview-3"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"oryAccessControlPolicy"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicy"}),"oryAccessControlPolicy"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"404"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.5.4"}),"Not Found")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"getoryaccesscontrolpolicy-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"404")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-3"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "actions": [\n    "string"\n  ],\n  "conditions": {},\n  "description": "string",\n  "effect": "string",\n  "id": "string",\n  "resources": [\n    "string"\n  ],\n  "subjects": [\n    "string"\n  ]\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-3"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-getOryAccessControlPolicy"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-getOryAccessControlPolicy-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicy-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicy-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicy-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicy-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicy-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-getOryAccessControlPolicy-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /engines/acp/ory/{flavor}/policies/{id} \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicy-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/engines/acp/ory/{flavor}/policies/{id}", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicy-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/policies/{id}', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicy-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/policies/{id}");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicy-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/engines/acp/ory/{flavor}/policies/{id}',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicy-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/engines/acp/ory/{flavor}/policies/{id}',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIddeleteOryAccessControlPolicy"}),Object(l.b)("h3",{id:"deleteoryaccesscontrolpolicy"},"deleteOryAccessControlPolicy"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"DELETE /engines/acp/ory/{flavor}/policies/{id} HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"Delete an ORY Access Control Policy"),Object(l.b)("a",{id:"deleteoryaccesscontrolpolicy-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The ID of the ORY Access Control Policy Role.")))),Object(l.b)("h4",{id:"responses-4"},"Responses"),Object(l.b)("a",{id:"deleteoryaccesscontrolpolicy-responses"}),Object(l.b)("h5",{id:"overview-4"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"204"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.5"}),"No Content")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"An empty response"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"None")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"deleteoryaccesscontrolpolicy-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-4"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"500 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "code": 0,\n  "details": [\n    {}\n  ],\n  "message": "string",\n  "reason": "string",\n  "request": "string",\n  "status": "string"\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-4"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-deleteOryAccessControlPolicy"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-deleteOryAccessControlPolicy-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicy-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicy-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicy-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicy-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicy-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-deleteOryAccessControlPolicy-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X DELETE /engines/acp/ory/{flavor}/policies/{id} \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicy-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("DELETE", "/engines/acp/ory/{flavor}/policies/{id}", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicy-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/policies/{id}', {\n  method: 'DELETE',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicy-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/policies/{id}");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("DELETE");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicy-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.delete(\n  '/engines/acp/ory/{flavor}/policies/{id}',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicy-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.delete '/engines/acp/ory/{flavor}/policies/{id}',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdlistOryAccessControlPolicyRoles"}),Object(l.b)("h3",{id:"list-ory-access-control-policy-roles"},"List ORY Access Control Policy Roles"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /engines/acp/ory/{flavor}/roles HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID\nas subject in the OACP."),Object(l.b)("a",{id:"list-ory-access-control-policy-roles-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact"')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"limit"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The maximum amount of policies returned.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"offset"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The offset from where to start looking.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"member"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"query"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The member for which the roles are to be listed.")))),Object(l.b)("h4",{id:"responses-5"},"Responses"),Object(l.b)("a",{id:"list-ory-access-control-policy-roles-responses"}),Object(l.b)("h5",{id:"overview-5"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Roles is an array of roles."),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"list-ory-access-control-policy-roles-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"200")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("em",{parentName:"td"},"anonymous")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[",Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicyrole"}),"oryAccessControlPolicyRole"),"]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[oryAccessControlPolicyRole represents a group of users that share the same role. A role could be an administrator, a moderator, a regular user or some other sort of role.]")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"ID is the role's unique id.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb members"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Members is who belongs to the role.")))),Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-5"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'[\n  {\n    "id": "string",\n    "members": [\n      "string"\n    ]\n  }\n]\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-5"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-listOryAccessControlPolicyRoles"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-listOryAccessControlPolicyRoles-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicyRoles-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicyRoles-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicyRoles-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicyRoles-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-listOryAccessControlPolicyRoles-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-listOryAccessControlPolicyRoles-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /engines/acp/ory/{flavor}/roles \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicyRoles-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/engines/acp/ory/{flavor}/roles", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicyRoles-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/roles', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicyRoles-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/roles");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicyRoles-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/engines/acp/ory/{flavor}/roles',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-listOryAccessControlPolicyRoles-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/engines/acp/ory/{flavor}/roles',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdupsertOryAccessControlPolicyRole"}),Object(l.b)("h3",{id:"upsert-an-ory-access-control-policy-role"},"Upsert an ORY Access Control Policy Role"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"PUT /engines/acp/ory/{flavor}/roles HTTP/1.1\nContent-Type: application/json\nAccept: application/json\n\n")),Object(l.b)("p",null,"Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID\nas subject in the OACP."),Object(l.b)("h4",{id:"request-body-2"},"Request body"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "id": "string",\n  "members": [\n    "string"\n  ]\n}\n')),Object(l.b)("a",{id:"upsert-an-ory-access-control-policy-role-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicyrole"}),"oryAccessControlPolicyRole")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h4",{id:"responses-6"},"Responses"),Object(l.b)("a",{id:"upsert-an-ory-access-control-policy-role-responses"}),Object(l.b)("h5",{id:"overview-6"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"oryAccessControlPolicyRole"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicyrole"}),"oryAccessControlPolicyRole"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"upsert-an-ory-access-control-policy-role-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-6"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "id": "string",\n  "members": [\n    "string"\n  ]\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-6"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-upsertOryAccessControlPolicyRole"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-upsertOryAccessControlPolicyRole-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicyRole-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicyRole-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicyRole-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicyRole-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-upsertOryAccessControlPolicyRole-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-upsertOryAccessControlPolicyRole-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X PUT /engines/acp/ory/{flavor}/roles \\\n  -H 'Content-Type: application/json' \\  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicyRole-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Content-Type": []string{"application/json"},\n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("PUT", "/engines/acp/ory/{flavor}/roles", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicyRole-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\nconst input = '{\n  \"id\": \"string\",\n  \"members\": [\n    \"string\"\n  ]\n}';\nconst headers = {\n  'Content-Type': 'application/json',  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/roles', {\n  method: 'PUT',\n  body: input,\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicyRole-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/roles");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("PUT");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicyRole-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Content-Type': 'application/json',\n  'Accept': 'application/json'\n}\n\nr = requests.put(\n  '/engines/acp/ory/{flavor}/roles',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-upsertOryAccessControlPolicyRole-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Content-Type' => 'application/json',\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.put '/engines/acp/ory/{flavor}/roles',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdgetOryAccessControlPolicyRole"}),Object(l.b)("h3",{id:"get-an-ory-access-control-policy-role"},"Get an ORY Access Control Policy Role"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /engines/acp/ory/{flavor}/roles/{id} HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID\nas subject in the OACP."),Object(l.b)("a",{id:"get-an-ory-access-control-policy-role-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The ID of the ORY Access Control Policy Role.")))),Object(l.b)("h4",{id:"responses-7"},"Responses"),Object(l.b)("a",{id:"get-an-ory-access-control-policy-role-responses"}),Object(l.b)("h5",{id:"overview-7"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"oryAccessControlPolicyRole"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicyrole"}),"oryAccessControlPolicyRole"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"404"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.5.4"}),"Not Found")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"get-an-ory-access-control-policy-role-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"404")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-7"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "id": "string",\n  "members": [\n    "string"\n  ]\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-7"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-getOryAccessControlPolicyRole"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-getOryAccessControlPolicyRole-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicyRole-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicyRole-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicyRole-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicyRole-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getOryAccessControlPolicyRole-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-getOryAccessControlPolicyRole-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /engines/acp/ory/{flavor}/roles/{id} \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicyRole-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/engines/acp/ory/{flavor}/roles/{id}", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicyRole-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/roles/{id}', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicyRole-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/roles/{id}");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicyRole-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/engines/acp/ory/{flavor}/roles/{id}',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getOryAccessControlPolicyRole-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/engines/acp/ory/{flavor}/roles/{id}',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIddeleteOryAccessControlPolicyRole"}),Object(l.b)("h3",{id:"delete-an-ory-access-control-policy-role"},"Delete an ORY Access Control Policy Role"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"DELETE /engines/acp/ory/{flavor}/roles/{id} HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID\nas subject in the OACP."),Object(l.b)("a",{id:"delete-an-ory-access-control-policy-role-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The ID of the ORY Access Control Policy Role.")))),Object(l.b)("h4",{id:"responses-8"},"Responses"),Object(l.b)("a",{id:"delete-an-ory-access-control-policy-role-responses"}),Object(l.b)("h5",{id:"overview-8"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"204"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.5"}),"No Content")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"An empty response"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"None")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"delete-an-ory-access-control-policy-role-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-8"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"500 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "code": 0,\n  "details": [\n    {}\n  ],\n  "message": "string",\n  "reason": "string",\n  "request": "string",\n  "status": "string"\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-8"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-deleteOryAccessControlPolicyRole"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-deleteOryAccessControlPolicyRole-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicyRole-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicyRole-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicyRole-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicyRole-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-deleteOryAccessControlPolicyRole-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-deleteOryAccessControlPolicyRole-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X DELETE /engines/acp/ory/{flavor}/roles/{id} \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicyRole-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("DELETE", "/engines/acp/ory/{flavor}/roles/{id}", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicyRole-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/roles/{id}', {\n  method: 'DELETE',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicyRole-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/roles/{id}");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("DELETE");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicyRole-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.delete(\n  '/engines/acp/ory/{flavor}/roles/{id}',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-deleteOryAccessControlPolicyRole-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.delete '/engines/acp/ory/{flavor}/roles/{id}',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdaddOryAccessControlPolicyRoleMembers"}),Object(l.b)("h3",{id:"add-a-member-to-an-ory-access-control-policy-role"},"Add a member to an ORY Access Control Policy Role"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"PUT /engines/acp/ory/{flavor}/roles/{id}/members HTTP/1.1\nContent-Type: application/json\nAccept: application/json\n\n")),Object(l.b)("p",null,"Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID\nas subject in the OACP."),Object(l.b)("h4",{id:"request-body-3"},"Request body"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "members": [\n    "string"\n  ]\n}\n')),Object(l.b)("a",{id:"add-a-member-to-an-ory-access-control-policy-role-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The ID of the ORY Access Control Policy Role.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"body"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaaddoryaccesscontrolpolicyrolemembersbody"}),"addOryAccessControlPolicyRoleMembersBody")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h4",{id:"responses-9"},"Responses"),Object(l.b)("a",{id:"add-a-member-to-an-ory-access-control-policy-role-responses"}),Object(l.b)("h5",{id:"overview-9"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"oryAccessControlPolicyRole"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaoryaccesscontrolpolicyrole"}),"oryAccessControlPolicyRole"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"add-a-member-to-an-ory-access-control-policy-role-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-9"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "id": "string",\n  "members": [\n    "string"\n  ]\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-9"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-addOryAccessControlPolicyRoleMembers"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-addOryAccessControlPolicyRoleMembers-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-addOryAccessControlPolicyRoleMembers-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-addOryAccessControlPolicyRoleMembers-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-addOryAccessControlPolicyRoleMembers-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-addOryAccessControlPolicyRoleMembers-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-addOryAccessControlPolicyRoleMembers-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-addOryAccessControlPolicyRoleMembers-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X PUT /engines/acp/ory/{flavor}/roles/{id}/members \\\n  -H 'Content-Type: application/json' \\  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-addOryAccessControlPolicyRoleMembers-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Content-Type": []string{"application/json"},\n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("PUT", "/engines/acp/ory/{flavor}/roles/{id}/members", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-addOryAccessControlPolicyRoleMembers-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\nconst input = '{\n  \"members\": [\n    \"string\"\n  ]\n}';\nconst headers = {\n  'Content-Type': 'application/json',  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/roles/{id}/members', {\n  method: 'PUT',\n  body: input,\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-addOryAccessControlPolicyRoleMembers-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/roles/{id}/members");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("PUT");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-addOryAccessControlPolicyRoleMembers-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Content-Type': 'application/json',\n  'Accept': 'application/json'\n}\n\nr = requests.put(\n  '/engines/acp/ory/{flavor}/roles/{id}/members',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-addOryAccessControlPolicyRoleMembers-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Content-Type' => 'application/json',\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.put '/engines/acp/ory/{flavor}/roles/{id}/members',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdremoveOryAccessControlPolicyRoleMembers"}),Object(l.b)("h3",{id:"remove-a-member-from-an-ory-access-control-policy-role"},"Remove a member from an ORY Access Control Policy Role"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"DELETE /engines/acp/ory/{flavor}/roles/{id}/members/{member} HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID\nas subject in the OACP."),Object(l.b)("a",{id:"remove-a-member-from-an-ory-access-control-policy-role-parameters"}),"##### Parameters",Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Parameter"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"In"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"flavor"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'The ORY Access Control Policy flavor. Can be "regex", "glob", and "exact".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The ID of the ORY Access Control Policy Role.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"member"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"path"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The member to be removed.")))),Object(l.b)("h4",{id:"responses-10"},"Responses"),Object(l.b)("a",{id:"remove-a-member-from-an-ory-access-control-policy-role-responses"}),Object(l.b)("h5",{id:"overview-10"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"An empty response"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"None")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"remove-a-member-from-an-ory-access-control-policy-role-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-10"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"500 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "code": 0,\n  "details": [\n    {}\n  ],\n  "message": "string",\n  "reason": "string",\n  "request": "string",\n  "status": "string"\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-10"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-removeOryAccessControlPolicyRoleMembers"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-removeOryAccessControlPolicyRoleMembers-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-removeOryAccessControlPolicyRoleMembers-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-removeOryAccessControlPolicyRoleMembers-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-removeOryAccessControlPolicyRoleMembers-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-removeOryAccessControlPolicyRoleMembers-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-removeOryAccessControlPolicyRoleMembers-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-removeOryAccessControlPolicyRoleMembers-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X DELETE /engines/acp/ory/{flavor}/roles/{id}/members/{member} \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-removeOryAccessControlPolicyRoleMembers-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("DELETE", "/engines/acp/ory/{flavor}/roles/{id}/members/{member}", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-removeOryAccessControlPolicyRoleMembers-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/engines/acp/ory/{flavor}/roles/{id}/members/{member}', {\n  method: 'DELETE',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-removeOryAccessControlPolicyRoleMembers-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/engines/acp/ory/{flavor}/roles/{id}/members/{member}");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("DELETE");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-removeOryAccessControlPolicyRoleMembers-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.delete(\n  '/engines/acp/ory/{flavor}/roles/{id}/members/{member}',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-removeOryAccessControlPolicyRoleMembers-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.delete '/engines/acp/ory/{flavor}/roles/{id}/members/{member}',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"ory-keto-health"}),"## health",Object(l.b)("a",{id:"opIdisInstanceAlive"}),Object(l.b)("h3",{id:"check-alive-status"},"Check alive status"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /health/alive HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"This endpoint returns a 200 status code when the HTTP server is up running.\nThis status does currently not include checks whether the database connection is working."),Object(l.b)("p",null,"If the service supports TLS Edge Termination, this endpoint does not require the\n",Object(l.b)("inlineCode",{parentName:"p"},"X-Forwarded-Proto")," header to be set."),Object(l.b)("p",null,"Be aware that if you are running multiple nodes of this service, the health status will never\nrefer to the cluster state, only to a single instance."),Object(l.b)("h4",{id:"responses-11"},"Responses"),Object(l.b)("a",{id:"check-alive-status-responses"}),Object(l.b)("h5",{id:"overview-11"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"healthStatus"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemahealthstatus"}),"healthStatus"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"500"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.1"}),"Internal Server Error")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The standard error format"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Inline")))),Object(l.b)("a",{id:"check-alive-status-responseschema"}),"##### Response Schema",Object(l.b)("p",null,"Status Code ",Object(l.b)("strong",{parentName:"p"},"500")),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb code"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"integer(int64)"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb details"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[object]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb message"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb reason"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb request"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("h5",{id:"examples-11"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "status": "string"\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-11"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-isInstanceAlive"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-isInstanceAlive-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceAlive-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceAlive-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceAlive-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceAlive-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceAlive-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-isInstanceAlive-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /health/alive \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceAlive-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/health/alive", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceAlive-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/health/alive', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceAlive-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/health/alive");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceAlive-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/health/alive',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceAlive-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/health/alive',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"opIdisInstanceReady"}),Object(l.b)("h3",{id:"check-readiness-status"},"Check readiness status"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /health/ready HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g.\nthe database) are responsive as well."),Object(l.b)("p",null,"If the service supports TLS Edge Termination, this endpoint does not require the\n",Object(l.b)("inlineCode",{parentName:"p"},"X-Forwarded-Proto")," header to be set."),Object(l.b)("p",null,"Be aware that if you are running multiple nodes of this service, the health status will never\nrefer to the cluster state, only to a single instance."),Object(l.b)("h4",{id:"responses-12"},"Responses"),Object(l.b)("a",{id:"check-readiness-status-responses"}),Object(l.b)("h5",{id:"overview-12"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"healthStatus"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemahealthstatus"}),"healthStatus"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"503"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.6.4"}),"Service Unavailable")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"healthNotReadyStatus"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemahealthnotreadystatus"}),"healthNotReadyStatus"))))),Object(l.b)("h5",{id:"examples-12"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "status": "string"\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-12"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-isInstanceReady"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-isInstanceReady-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceReady-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceReady-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceReady-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceReady-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-isInstanceReady-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-isInstanceReady-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /health/ready \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceReady-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/health/ready", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceReady-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/health/ready', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceReady-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/health/ready");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceReady-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/health/ready',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-isInstanceReady-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/health/ready',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("a",{id:"ory-keto-version"}),"## version",Object(l.b)("a",{id:"opIdgetVersion"}),Object(l.b)("h3",{id:"get-service-version"},"Get service version"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{}),"GET /version HTTP/1.1\nAccept: application/json\n\n")),Object(l.b)("p",null,"This endpoint returns the service version typically notated using semantic versioning."),Object(l.b)("p",null,"If the service supports TLS Edge Termination, this endpoint does not require the\n",Object(l.b)("inlineCode",{parentName:"p"},"X-Forwarded-Proto")," header to be set."),Object(l.b)("p",null,"Be aware that if you are running multiple nodes of this service, the health status will never\nrefer to the cluster state, only to a single instance."),Object(l.b)("h4",{id:"responses-13"},"Responses"),Object(l.b)("a",{id:"get-service-version-responses"}),Object(l.b)("h5",{id:"overview-13"},"Overview"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Status"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Meaning"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Schema"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"200"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"https://tools.ietf.org/html/rfc7231#section-6.3.1"}),"OK")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"version"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("a",Object(n.a)({parentName:"td"},{href:"#schemaversion"}),"version"))))),Object(l.b)("h5",{id:"examples-13"},"Examples"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"200 Response")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "version": "string"\n}\n')),Object(l.b)("aside",{class:"success"},"This operation does not require authentication"),Object(l.b)("h4",{id:"code-samples-13"},"Code samples"),Object(l.b)("div",{class:"tabs",id:"tab-getVersion"},Object(l.b)("nav",{class:"tabs-nav"},Object(l.b)("ul",{class:"nav nav-tabs au-link-list au-link-list--inline"},Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link active",role:"tab",href:"#tab-getVersion-shell"},"Shell")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getVersion-go"},"Go")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getVersion-node"},"Node.js")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getVersion-java"},"Java")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getVersion-python"},"Python")),Object(l.b)("li",{class:"nav-item"},Object(l.b)("a",{class:"nav-link",role:"tab",href:"#tab-getVersion-ruby"},"Ruby")))),Object(l.b)("div",{class:"tab-content"},Object(l.b)("div",{class:"tab-pane active",role:"tabpanel",id:"tab-getVersion-shell"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-shell"}),"curl -X GET /version \\\n  -H 'Accept: application/json'\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getVersion-go"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-go"}),'package main\n\nimport (\n    "bytes"\n    "net/http"\n)\n\nfunc main() {\n    headers := map[string][]string{ \n        "Accept": []string{"application/json"},\n    }\n\n    var body []byte\n    // body = ...\n\n    req, err := http.NewRequest("GET", "/version", bytes.NewBuffer(body))\n    req.Header = headers\n\n    client := &http.Client{}\n    resp, err := client.Do(req)\n    // ...\n}\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getVersion-node"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-nodejs"}),"const fetch = require('node-fetch');\n\nconst headers = {\n  'Accept': 'application/json'\n}\n\nfetch('/version', {\n  method: 'GET',\n  headers\n})\n.then(r => r.json())\n.then((body) => {\n    console.log(body)\n})\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getVersion-java"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-java"}),'// This sample needs improvement.\nURL obj = new URL("/version");\n\nHttpURLConnection con = (HttpURLConnection) obj.openConnection();\ncon.setRequestMethod("GET");\n\nint responseCode = con.getResponseCode();\n\nBufferedReader in = new BufferedReader(\n    new InputStreamReader(con.getInputStream())\n);\n\nString inputLine;\nStringBuffer response = new StringBuffer();\nwhile ((inputLine = in.readLine()) != null) {\n    response.append(inputLine);\n}\nin.close();\n\nSystem.out.println(response.toString());\n'))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getVersion-python"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),"import requests\n\nheaders = {\n  'Accept': 'application/json'\n}\n\nr = requests.get(\n  '/version',\n  params={},\n  headers = headers)\n\nprint r.json()\n"))),Object(l.b)("div",{class:"tab-pane",role:"tabpanel",id:"tab-getVersion-ruby"},Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-ruby"}),"require 'rest-client'\nrequire 'json'\n\nheaders = {\n  'Accept' => 'application/json'\n}\n\nresult = RestClient.get '/version',\n  params: {}, headers: headers\n\np JSON.parse(result)\n"))))),Object(l.b)("h2",{id:"schemas"},"Schemas"),Object(l.b)("a",{id:"tocSaddoryaccesscontrolpolicyrolemembersbody"},"addOryAccessControlPolicyRoleMembersBody"),"#### addOryAccessControlPolicyRoleMembersBody",Object(l.b)("a",{id:"schemaaddoryaccesscontrolpolicyrolemembersbody"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "members": [\n    "string"\n  ]\n}\n\n')),Object(l.b)("h4",{id:"properties"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"members"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"The members to be added.")))),Object(l.b)("a",{id:"tocSauthorizationresult"},"authorizationResult"),"#### authorizationResult",Object(l.b)("a",{id:"schemaauthorizationresult"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "allowed": true\n}\n\n')),Object(l.b)("p",null,Object(l.b)("em",{parentName:"p"},"AuthorizationResult is the result of an access control decision. It contains the decision outcome.")),Object(l.b)("h4",{id:"properties-1"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"allowed"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"boolean"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"true"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Allowed is true if the request should be allowed and false otherwise.")))),Object(l.b)("a",{id:"tocShealthnotreadystatus"},"healthNotReadyStatus"),"#### healthNotReadyStatus",Object(l.b)("a",{id:"schemahealthnotreadystatus"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "errors": {\n    "property1": "string",\n    "property2": "string"\n  }\n}\n\n')),Object(l.b)("h4",{id:"properties-2"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"errors"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"object"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Errors contains a list of errors that caused the not ready status.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"\xbb ",Object(l.b)("strong",{parentName:"td"},"additionalProperties")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none")))),Object(l.b)("a",{id:"tocShealthstatus"},"healthStatus"),"#### healthStatus",Object(l.b)("a",{id:"schemahealthstatus"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "status": "string"\n}\n\n')),Object(l.b)("h4",{id:"properties-3"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"status"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'Status always contains "ok".')))),Object(l.b)("a",{id:"tocSoryaccesscontrolpolicy"},"oryAccessControlPolicy"),"#### oryAccessControlPolicy",Object(l.b)("a",{id:"schemaoryaccesscontrolpolicy"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "actions": [\n    "string"\n  ],\n  "conditions": {},\n  "description": "string",\n  "effect": "string",\n  "id": "string",\n  "resources": [\n    "string"\n  ],\n  "subjects": [\n    "string"\n  ]\n}\n\n')),Object(l.b)("p",null,Object(l.b)("em",{parentName:"p"},"oryAccessControlPolicy specifies an ORY Access Policy document.")),Object(l.b)("h4",{id:"properties-4"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"actions"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Actions is an array representing all the actions this ORY Access Policy applies to.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"conditions"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"object"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Conditions represents a keyed object of conditions under which this ORY Access Policy is active.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"description"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Description is an optional, human-readable description.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"effect"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),'Effect is the effect of this ORY Access Policy. It can be "allow" or "deny".')),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"resources"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Resources is an array representing all the resources this ORY Access Policy applies to.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"subjects"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Subjects is an array representing all the subjects this ORY Access Policy applies to.")))),Object(l.b)("a",{id:"tocSoryaccesscontrolpolicyallowedinput"},"oryAccessControlPolicyAllowedInput"),"#### oryAccessControlPolicyAllowedInput",Object(l.b)("a",{id:"schemaoryaccesscontrolpolicyallowedinput"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "action": "string",\n  "context": {},\n  "resource": "string",\n  "subject": "string"\n}\n\n')),Object(l.b)("p",null,Object(l.b)("em",{parentName:"p"},"Input for checking if a request is allowed or not.")),Object(l.b)("h4",{id:"properties-5"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"action"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Action is the action that is requested on the resource.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"context"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"object"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Context is the request's environmental context.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"resource"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Resource is the resource that access is requested to.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"subject"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Subject is the subject that is requesting access.")))),Object(l.b)("a",{id:"tocSoryaccesscontrolpolicyrole"},"oryAccessControlPolicyRole"),"#### oryAccessControlPolicyRole",Object(l.b)("a",{id:"schemaoryaccesscontrolpolicyrole"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "id": "string",\n  "members": [\n    "string"\n  ]\n}\n\n')),Object(l.b)("p",null,Object(l.b)("em",{parentName:"p"},"oryAccessControlPolicyRole represents a group of users that share the same role. A role could be an administrator, a moderator, a regular\nuser or some other sort of role.")),Object(l.b)("h4",{id:"properties-6"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"id"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"ID is the role's unique id.")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"members"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"[string]"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Members is who belongs to the role.")))),Object(l.b)("a",{id:"tocSversion"},"version"),"#### version",Object(l.b)("a",{id:"schemaversion"}),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-json"}),'{\n  "version": "string"\n}\n\n')),Object(l.b)("h4",{id:"properties-7"},"Properties"),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Name"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Required"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Restrictions"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"version"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"string"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"false"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"none"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Version is the service's version.")))))}i.isMDXComponent=!0},174:function(e,t,a){"use strict";a.d(t,"a",(function(){return j})),a.d(t,"b",(function(){return d}));var n=a(0),b=a.n(n);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function c(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?r(Object(a),!0).forEach((function(t){l(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):r(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,n,b=function(e,t){if(null==e)return{};var a,n,b={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(b[a]=e[a]);return b}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(b[a]=e[a])}return b}var o=b.a.createContext({}),i=function(e){var t=b.a.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):c(c({},t),e)),a},j=function(e){var t=i(e.components);return b.a.createElement(o.Provider,{value:t},e.children)},O={inlineCode:"code",wrapper:function(e){var t=e.children;return b.a.createElement(b.a.Fragment,{},t)}},p=b.a.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,r=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),j=i(a),p=n,d=j["".concat(r,".").concat(p)]||j[p]||O[p]||l;return a?b.a.createElement(d,c(c({ref:t},o),{},{components:a})):b.a.createElement(d,c({ref:t},o))}));function d(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,r=new Array(l);r[0]=p;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c.mdxType="string"==typeof e?e:n,r[1]=c;for(var o=2;o<l;o++)r[o]=a[o];return b.a.createElement.apply(null,r)}return b.a.createElement.apply(null,a)}p.displayName="MDXCreateElement"}}]);