diff --git a/docs/docs/configure-deploy.md b/docs/docs/configure-deploy.md index 6871caf5c..35170672c 100644 --- a/docs/docs/configure-deploy.md +++ b/docs/docs/configure-deploy.md @@ -66,7 +66,7 @@ $ export DSN=postgres://keto:secret@ory-keto-example--postgres:5432/keto?sslmode $ docker run -it --rm \ --network ketoguide \ -e DSN=$DSN \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ migrate sql -e Applying `client` SQL migrations... @@ -79,7 +79,7 @@ $ docker run -d \ --network ketoguide \ -p 4466:4466 \ -e DSN=$DSN \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ serve ``` @@ -120,7 +120,7 @@ $ docker run -it --rm \ --network ketoguide \ -v $(pwd)/policies:/policies \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory policies import exact /policies/example-policy.json ``` @@ -130,7 +130,7 @@ Check if the policy has been created: $ docker run -it --rm \ --network ketoguide \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory policies get exact example-policy { "actions": [ @@ -145,7 +145,7 @@ Check if Alice is allowed to delete the blog post: $ docker run -it --rm \ --network ketoguide \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory allowed exact alice blog_posts:my-first-blog-post delete { "allowed": true @@ -158,7 +158,7 @@ Other users like Bob can not delete it: $ docker run -it --rm \ --network ketoguide \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory allowed exact bob blog_posts:my-first-blog-post delete { "allowed": false diff --git a/docs/docs/install.md b/docs/docs/install.md index db6c95a60..ac0350784 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers. We recommend using Docker to run ORY Keto: ```shell -$ docker pull oryd/keto:v0.4.4-alpha.1 -$ docker run --rm -it oryd/keto:v0.4.4-alpha.1 help +$ docker pull oryd/keto:v0.5.5-alpha.1 +$ docker run --rm -it oryd/keto:v0.5.5-alpha.1 help ``` ## macOS @@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary using: ```shell -$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.4.4-alpha.1 +$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.5.5-alpha.1 $ ./keto help ``` diff --git a/docs/docs/reference/api.md b/docs/docs/reference/api.md index 6404b8351..b8c47dd77 100644 --- a/docs/docs/reference/api.md +++ b/docs/docs/reference/api.md @@ -43,10 +43,7 @@ is denied, a 403 response with `{"allowed":"false"}` will be sent instead. ```json { "action": "string", - "context": { - "property1": {}, - "property2": {} - }, + "context": {}, "resource": "string", "subject": "string" } @@ -79,15 +76,14 @@ is denied, a 403 response with `{"allowed":"false"}` will be sent instead. Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -160,10 +156,7 @@ func main() { const fetch = require('node-fetch'); const input = '{ "action": "string", - "context": { - "property1": {}, - "property2": {} - }, + "context": {}, "resource": "string", "subject": "string" }'; @@ -297,7 +290,6 @@ Status Code **200** | » oryAccessControlPolicy specifies an ORY Access Policy document. | [oryAccessControlPolicy](#schemaoryaccesscontrolpolicy) | false | none | none | | »» actions | [string] | false | none | Actions is an array representing all the actions this ORY Access Policy applies to. | | »» conditions | object | false | none | Conditions represents a keyed object of conditions under which this ORY Access Policy is active. | -| »»» **additionalProperties** | object | false | none | none | | »» description | string | false | none | Description is an optional, human-readable description. | | »» effect | string | false | none | Effect is the effect of this ORY Access Policy. It can be "allow" or "deny". | | »» id | string | false | none | ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy. | @@ -306,15 +298,14 @@ Status Code **200** Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -324,10 +315,7 @@ Status Code **500** [ { "actions": ["string"], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -493,10 +481,7 @@ Upsert an ORY Access Control Policy ```json { "actions": ["string"], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -531,15 +516,14 @@ Upsert an ORY Access Control Policy Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -548,10 +532,7 @@ Status Code **500** ```json { "actions": ["string"], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -623,10 +604,7 @@ const input = '{ "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -758,27 +736,25 @@ Get an ORY Access Control Policy Status Code **404** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -787,10 +763,7 @@ Status Code **500** ```json { "actions": ["string"], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -975,15 +948,14 @@ Delete an ORY Access Control Policy Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -992,12 +964,7 @@ Status Code **500** ```json { "code": 0, - "details": [ - { - "property1": {}, - "property2": {} - } - ], + "details": [{}], "message": "string", "reason": "string", "request": "string", @@ -1192,15 +1159,14 @@ Status Code **200** Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -1402,15 +1368,14 @@ Control Policy (OACP) by using the Role ID as subject in the OACP. Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -1610,27 +1575,25 @@ Control Policy (OACP) by using the Role ID as subject in the OACP. Status Code **404** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -1820,15 +1783,14 @@ Control Policy (OACP) by using the Role ID as subject in the OACP. Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -1837,12 +1799,7 @@ Status Code **500** ```json { "code": 0, - "details": [ - { - "property1": {}, - "property2": {} - } - ], + "details": [{}], "message": "string", "reason": "string", "request": "string", @@ -2037,15 +1994,14 @@ Control Policy (OACP) by using the Role ID as subject in the OACP. Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -2244,15 +2200,14 @@ Control Policy (OACP) by using the Role ID as subject in the OACP. Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -2261,12 +2216,7 @@ Status Code **500** ```json { "code": 0, - "details": [ - { - "property1": {}, - "property2": {} - } - ], + "details": [{}], "message": "string", "reason": "string", "request": "string", @@ -2453,15 +2403,14 @@ status will never refer to the cluster state, only to a single instance. Status Code **500** -| Name | Type | Required | Restrictions | Description | -| --------------------------- | -------------- | -------- | ------------ | ----------- | -| » code | integer(int64) | false | none | none | -| » details | [object] | false | none | none | -| »» **additionalProperties** | object | false | none | none | -| » message | string | false | none | none | -| » reason | string | false | none | none | -| » request | string | false | none | none | -| » status | string | false | none | none | +| Name | Type | Required | Restrictions | Description | +| --------- | -------------- | -------- | ------------ | ----------- | +| » code | integer(int64) | false | none | none | +| » details | [object] | false | none | none | +| » message | string | false | none | none | +| » reason | string | false | none | none | +| » request | string | false | none | none | +| » status | string | false | none | none | ##### Examples @@ -3060,10 +3009,7 @@ the decision outcome._ ```json { "actions": ["string"], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -3076,16 +3022,15 @@ _oryAccessControlPolicy specifies an ORY Access Policy document._ #### Properties -| Name | Type | Required | Restrictions | Description | -| -------------------------- | -------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------- | -| actions | [string] | false | none | Actions is an array representing all the actions this ORY Access Policy applies to. | -| conditions | object | false | none | Conditions represents a keyed object of conditions under which this ORY Access Policy is active. | -| » **additionalProperties** | object | false | none | none | -| description | string | false | none | Description is an optional, human-readable description. | -| effect | string | false | none | Effect is the effect of this ORY Access Policy. It can be "allow" or "deny". | -| id | string | false | none | ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy. | -| resources | [string] | false | none | Resources is an array representing all the resources this ORY Access Policy applies to. | -| subjects | [string] | false | none | Subjects is an array representing all the subjects this ORY Access Policy applies to. | +| Name | Type | Required | Restrictions | Description | +| ----------- | -------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------- | +| actions | [string] | false | none | Actions is an array representing all the actions this ORY Access Policy applies to. | +| conditions | object | false | none | Conditions represents a keyed object of conditions under which this ORY Access Policy is active. | +| description | string | false | none | Description is an optional, human-readable description. | +| effect | string | false | none | Effect is the effect of this ORY Access Policy. It can be "allow" or "deny". | +| id | string | false | none | ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy. | +| resources | [string] | false | none | Resources is an array representing all the resources this ORY Access Policy applies to. | +| subjects | [string] | false | none | Subjects is an array representing all the subjects this ORY Access Policy applies to. | oryAccessControlPolicyAllowedInput @@ -3096,10 +3041,7 @@ _oryAccessControlPolicy specifies an ORY Access Policy document._ ```json { "action": "string", - "context": { - "property1": {}, - "property2": {} - }, + "context": {}, "resource": "string", "subject": "string" } @@ -3109,13 +3051,12 @@ _Input for checking if a request is allowed or not._ #### Properties -| Name | Type | Required | Restrictions | Description | -| -------------------------- | ------ | -------- | ------------ | ------------------------------------------------------- | -| action | string | false | none | Action is the action that is requested on the resource. | -| context | object | false | none | Context is the request's environmental context. | -| » **additionalProperties** | object | false | none | none | -| resource | string | false | none | Resource is the resource that access is requested to. | -| subject | string | false | none | Subject is the subject that is requesting access. | +| Name | Type | Required | Restrictions | Description | +| -------- | ------ | -------- | ------------ | ------------------------------------------------------- | +| action | string | false | none | Action is the action that is requested on the resource. | +| context | object | false | none | Context is the request's environmental context. | +| resource | string | false | none | Resource is the resource that access is requested to. | +| subject | string | false | none | Subject is the subject that is requesting access. | oryAccessControlPolicyRole diff --git a/docs/docs/reference/configuration.md b/docs/docs/reference/configuration.md index 0896b0fdc..41beda19a 100644 --- a/docs/docs/reference/configuration.md +++ b/docs/docs/reference/configuration.md @@ -78,7 +78,7 @@ serve: # - Windows Command Line (CMD): # > set SERVE_HOST= # - host: localhost + host: 127.0.0.1 ## Cross Origin Resource Sharing (CORS) ## # @@ -117,9 +117,7 @@ serve: # > set SERVE_CORS_ALLOWED_ORIGINS= # allowed_origins: - - https://example.com - - https://*.example.com - - https://*.foo.example.com + - '*' ## Allowed HTTP Methods ## # @@ -134,11 +132,7 @@ serve: # > set SERVE_CORS_ALLOWED_METHODS= # allowed_methods: - - PUT - - POST - - GET - - TRACE - - DELETE + - HEAD ## Allowed Request HTTP Headers ## # @@ -153,11 +147,9 @@ serve: # > set SERVE_CORS_ALLOWED_HEADERS= # allowed_headers: - - officia aliqua - - irure - - Duis irure aliqua aute - - Duis officia sed dolor irure - - labore consequat + - consequat tempor commodo dolore incididunt + - dolore in + - incididunt et Duis ## Allowed Response HTTP Headers ## # @@ -172,10 +164,10 @@ serve: # > set SERVE_CORS_EXPOSED_HEADERS= # exposed_headers: - - in proident Duis exercitation pariatur - - nostrud - - commodo Ut - - do adipisicing + - ad fugiat irure voluptate + - pariatur esse anim sed + - quis in + - amet ## Allow HTTP Credentials ## # @@ -201,7 +193,7 @@ serve: # - Windows Command Line (CMD): # > set SERVE_CORS_MAX_AGE= # - max_age: 36592762 + max_age: 82288709 ## Enable Debugging ## # @@ -278,7 +270,7 @@ serve: # - Windows Command Line (CMD): # > set PROFILING= # -profiling: cpu +profiling: '' ## Log ## # @@ -297,7 +289,7 @@ log: # - Windows Command Line (CMD): # > set LOG_LEVEL= # - level: error + level: debug ## Format ## # @@ -311,7 +303,7 @@ log: # - Windows Command Line (CMD): # > set LOG_FORMAT= # - format: json + format: text ## tracing ## # diff --git a/docs/versioned_docs/version-v0.5/configure-deploy.md b/docs/versioned_docs/version-v0.5/configure-deploy.md index 6871caf5c..35170672c 100644 --- a/docs/versioned_docs/version-v0.5/configure-deploy.md +++ b/docs/versioned_docs/version-v0.5/configure-deploy.md @@ -66,7 +66,7 @@ $ export DSN=postgres://keto:secret@ory-keto-example--postgres:5432/keto?sslmode $ docker run -it --rm \ --network ketoguide \ -e DSN=$DSN \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ migrate sql -e Applying `client` SQL migrations... @@ -79,7 +79,7 @@ $ docker run -d \ --network ketoguide \ -p 4466:4466 \ -e DSN=$DSN \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ serve ``` @@ -120,7 +120,7 @@ $ docker run -it --rm \ --network ketoguide \ -v $(pwd)/policies:/policies \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory policies import exact /policies/example-policy.json ``` @@ -130,7 +130,7 @@ Check if the policy has been created: $ docker run -it --rm \ --network ketoguide \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory policies get exact example-policy { "actions": [ @@ -145,7 +145,7 @@ Check if Alice is allowed to delete the blog post: $ docker run -it --rm \ --network ketoguide \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory allowed exact alice blog_posts:my-first-blog-post delete { "allowed": true @@ -158,7 +158,7 @@ Other users like Bob can not delete it: $ docker run -it --rm \ --network ketoguide \ -e KETO_URL=http://ory-keto-example--keto:4466/ \ - oryd/keto:v0.5.4-alpha.1 \ + oryd/keto:v0.5.5-alpha.1 \ engines acp ory allowed exact bob blog_posts:my-first-blog-post delete { "allowed": false diff --git a/docs/versioned_docs/version-v0.5/install.md b/docs/versioned_docs/version-v0.5/install.md index b6fef15de..ac0350784 100644 --- a/docs/versioned_docs/version-v0.5/install.md +++ b/docs/versioned_docs/version-v0.5/install.md @@ -11,8 +11,8 @@ binaries, Docker images, and support a number of package managers. We recommend using Docker to run ORY Keto: ```shell -$ docker pull oryd/keto:v0.5.4-alpha.1 -$ docker run --rm -it oryd/keto:v0.5.4-alpha.1 help +$ docker pull oryd/keto:v0.5.5-alpha.1 +$ docker run --rm -it oryd/keto:v0.5.5-alpha.1 help ``` ## macOS @@ -27,10 +27,11 @@ $ keto help ## Linux -On linux, you can use `curl | bash` to fetch the latest stable binary using: +On linux, you can use `bash <(curl ...)` to fetch the latest stable binary +using: ```shell -$ curl https://raw.githubusercontent.com/ory/keto/master/install.sh | bash -s -- -b . +$ bash <(curl https://raw.githubusercontent.com/ory/keto/master/install.sh) -b . v0.5.5-alpha.1 $ ./keto help ``` diff --git a/docs/versioned_docs/version-v0.5/reference/api.md b/docs/versioned_docs/version-v0.5/reference/api.md index 8e1faf6cf..e52807025 100644 --- a/docs/versioned_docs/version-v0.5/reference/api.md +++ b/docs/versioned_docs/version-v0.5/reference/api.md @@ -39,10 +39,7 @@ be sent instead. ```json { "action": "string", - "context": { - "property1": {}, - "property2": {} - }, + "context": {}, "resource": "string", "subject": "string" } @@ -76,7 +73,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -153,10 +149,7 @@ func main() { const fetch = require('node-fetch'); const input = '{ "action": "string", - "context": { - "property1": {}, - "property2": {} - }, + "context": {}, "resource": "string", "subject": "string" }'; @@ -287,7 +280,6 @@ Status Code **200** |» oryAccessControlPolicy specifies an ORY Access Policy document.|[oryAccessControlPolicy](#schemaoryaccesscontrolpolicy)|false|none|none| |»» actions|[string]|false|none|Actions is an array representing all the actions this ORY Access Policy applies to.| |»» conditions|object|false|none|Conditions represents a keyed object of conditions under which this ORY Access Policy is active.| -|»»» **additionalProperties**|object|false|none|none| |»» description|string|false|none|Description is an optional, human-readable description.| |»» effect|string|false|none|Effect is the effect of this ORY Access Policy. It can be "allow" or "deny".| |»» id|string|false|none|ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy.| @@ -300,7 +292,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -316,10 +307,7 @@ Status Code **500** "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -491,10 +479,7 @@ Upsert an ORY Access Control Policy "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -534,7 +519,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -549,10 +533,7 @@ Status Code **500** "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -628,10 +609,7 @@ const input = '{ "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -764,7 +742,6 @@ Status Code **404** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -776,7 +753,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -791,10 +767,7 @@ Status Code **500** "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -984,7 +957,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -998,10 +970,7 @@ Status Code **500** { "code": 0, "details": [ - { - "property1": {}, - "property2": {} - } + {} ], "message": "string", "reason": "string", @@ -1198,7 +1167,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -1409,7 +1377,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -1616,7 +1583,6 @@ Status Code **404** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -1628,7 +1594,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -1825,7 +1790,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -1839,10 +1803,7 @@ Status Code **500** { "code": 0, "details": [ - { - "property1": {}, - "property2": {} - } + {} ], "message": "string", "reason": "string", @@ -2041,7 +2002,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -2247,7 +2207,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -2261,10 +2220,7 @@ Status Code **500** { "code": 0, "details": [ - { - "property1": {}, - "property2": {} - } + {} ], "message": "string", "reason": "string", @@ -2452,7 +2408,6 @@ Status Code **500** |---|---|---|---|---| |» code|integer(int64)|false|none|none| |» details|[object]|false|none|none| -|»» **additionalProperties**|object|false|none|none| |» message|string|false|none|none| |» reason|string|false|none|none| |» request|string|false|none|none| @@ -3053,10 +3008,7 @@ p JSON.parse(result) "actions": [ "string" ], - "conditions": { - "property1": {}, - "property2": {} - }, + "conditions": {}, "description": "string", "effect": "string", "id": "string", @@ -3078,7 +3030,6 @@ p JSON.parse(result) |---|---|---|---|---| |actions|[string]|false|none|Actions is an array representing all the actions this ORY Access Policy applies to.| |conditions|object|false|none|Conditions represents a keyed object of conditions under which this ORY Access Policy is active.| -|» **additionalProperties**|object|false|none|none| |description|string|false|none|Description is an optional, human-readable description.| |effect|string|false|none|Effect is the effect of this ORY Access Policy. It can be "allow" or "deny".| |id|string|false|none|ID is the unique identifier of the ORY Access Policy. It is used to query, update, and remove the ORY Access Policy.| @@ -3093,10 +3044,7 @@ p JSON.parse(result) ```json { "action": "string", - "context": { - "property1": {}, - "property2": {} - }, + "context": {}, "resource": "string", "subject": "string" } @@ -3111,7 +3059,6 @@ p JSON.parse(result) |---|---|---|---|---| |action|string|false|none|Action is the action that is requested on the resource.| |context|object|false|none|Context is the request's environmental context.| -|» **additionalProperties**|object|false|none|none| |resource|string|false|none|Resource is the resource that access is requested to.| |subject|string|false|none|Subject is the subject that is requesting access.| diff --git a/docs/versioned_docs/version-v0.5/reference/configuration.md b/docs/versioned_docs/version-v0.5/reference/configuration.md index 06f049cb7..7c5ea90c2 100644 --- a/docs/versioned_docs/version-v0.5/reference/configuration.md +++ b/docs/versioned_docs/version-v0.5/reference/configuration.md @@ -76,7 +76,7 @@ serve: # - Windows Command Line (CMD): # > set SERVE_HOST= # - host: localhost + host: 127.0.0.1 ## Cross Origin Resource Sharing (CORS) ## # @@ -116,9 +116,7 @@ serve: # > set SERVE_CORS_ALLOWED_ORIGINS= # allowed_origins: - - https://example.com - - https://*.example.com - - https://*.foo.example.com + - "*" ## Allowed HTTP Methods ## # @@ -133,11 +131,7 @@ serve: # > set SERVE_CORS_ALLOWED_METHODS= # allowed_methods: - - PATCH - HEAD - - POST - - CONNECT - - TRACE ## Allowed Request HTTP Headers ## # @@ -152,9 +146,9 @@ serve: # > set SERVE_CORS_ALLOWED_HEADERS= # allowed_headers: - - dolore - - nostrud ea - - nostrud ut qui + - consequat tempor commodo dolore incididunt + - dolore in + - incididunt et Duis ## Allowed Response HTTP Headers ## # @@ -169,11 +163,10 @@ serve: # > set SERVE_CORS_EXPOSED_HEADERS= # exposed_headers: - - magna laborum amet nostrud laboris - - eu consequat do - - laborum voluptate deserunt fugiat cillum - - in - - consequat consectetur exercitation proident + - ad fugiat irure voluptate + - pariatur esse anim sed + - quis in + - amet ## Allow HTTP Credentials ## # @@ -199,7 +192,7 @@ serve: # - Windows Command Line (CMD): # > set SERVE_CORS_MAX_AGE= # - max_age: 75363283 + max_age: 82288709 ## Enable Debugging ## # @@ -279,7 +272,7 @@ serve: # - Windows Command Line (CMD): # > set PROFILING= # -profiling: mem +profiling: "" ## Log ## # @@ -313,7 +306,7 @@ log: # - Windows Command Line (CMD): # > set LOG_FORMAT= # - format: json + format: text ## tracing ## # diff --git a/docs/versioned_sidebars/version-v0.5-sidebars.json b/docs/versioned_sidebars/version-v0.5-sidebars.json index 9a97560e8..a0b215fd4 100644 --- a/docs/versioned_sidebars/version-v0.5-sidebars.json +++ b/docs/versioned_sidebars/version-v0.5-sidebars.json @@ -140,27 +140,6 @@ "href": "https://github.com/ory/oathkeeper" } ] - }, - { - "type": "category", - "label": "ORY Keto", - "items": [ - { - "type": "link", - "label": "Home", - "href": "https://www.ory.sh/Keto" - }, - { - "type": "link", - "label": "Docs", - "href": "https://www.ory.sh/Keto/docs" - }, - { - "type": "link", - "label": "GitHub", - "href": "https://github.com/ory/Keto" - } - ] } ] } diff --git a/go.mod b/go.mod index dcf63df8e..ee7ad92bd 100644 --- a/go.mod +++ b/go.mod @@ -26,7 +26,7 @@ require ( github.com/ory/go-acc v0.2.1 github.com/ory/graceful v0.1.1 github.com/ory/herodot v0.8.3 - github.com/ory/sdk/swagutil v0.0.0-20200417161747-f12e98ecfd2e + github.com/ory/sdk/swagutil v0.0.0-20200525104141-b009efcf4f04 github.com/ory/viper v1.7.5 github.com/ory/x v0.0.124 github.com/pborman/uuid v1.2.0 diff --git a/go.sum b/go.sum index 3e19988f3..f7e0dd0e2 100644 --- a/go.sum +++ b/go.sum @@ -796,6 +796,8 @@ github.com/ory/jsonschema/v3 v3.0.1 h1:xzV7w2rt/Qn+jvh71joIXNKKOCqqNyTlaIxdxU0IQ github.com/ory/jsonschema/v3 v3.0.1/go.mod h1:jgLHekkFk0uiGdEWGleC+tOm6JSSP8cbf17PnBuGXlw= github.com/ory/sdk/swagutil v0.0.0-20200417161747-f12e98ecfd2e h1:TvoA41hKo0Gr8ZQaq54Qcshyn6oGHDZ5i0vfSE5eVaU= github.com/ory/sdk/swagutil v0.0.0-20200417161747-f12e98ecfd2e/go.mod h1:Ufg1eAyz+Zt3+oweSZVThG13ewewWCKwBmoNmK8Z0co= +github.com/ory/sdk/swagutil v0.0.0-20200525104141-b009efcf4f04 h1:X4Pq1sjENXZjDTyVFpeiZUZppuS2rhddwEZ/ujc+MUk= +github.com/ory/sdk/swagutil v0.0.0-20200525104141-b009efcf4f04/go.mod h1:71A/G1sB4wLBi2cvhOSC0RYb6KkiFKTaPMwoq/2gTqU= github.com/ory/viper v1.5.6 h1:w4ceGgWwWLzAFYQ7bHaDZmwNsAto2JPVdyQjQnn7VWI= github.com/ory/viper v1.5.6/go.mod h1:TYmpFpKLxjQwvT4f0QPpkOn4sDXU1kDgAwJpgLYiQ28= github.com/ory/viper v1.7.4 h1:3RWBt7Pq9kSFNxLaRT0ljNdbtaWisCQG1cLPn2Yd4UY=