Skip to content

Commit

Permalink
autogen(docs): generate cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ory-bot committed Dec 29, 2023
1 parent 2d56b05 commit ba6fdc8
Show file tree
Hide file tree
Showing 8 changed files with 163 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/cli/ory-create-organization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
id: ory-create-organization
title: ory create organization
description: ory create organization Create a new Ory Network organization
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory create organization

Create a new Ory Network organization

```
ory create organization label [--project=PROJECT_ID] [--domains=a.example.com,b.example.com] [flags]
```

### Options

```
-d, --domains strings A list of domains that will be used for this organization.
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for organization
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory create](ory-create) - Create Ory Network resources

1 change: 1 addition & 0 deletions docs/cli/ory-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Create Ory Network resources
* [ory](ory) - The ORY CLI
* [ory create jwk](ory-create-jwk) - Create a JSON Web Key Set with a JSON Web Key
* [ory create oauth2-client](ory-create-oauth2-client) - Create an OAuth 2.0 Client
* [ory create organization](ory-create-organization) - Create a new Ory Network organization
* [ory create project](ory-create-project) - Create a new Ory Network project
* [ory create relationships](ory-create-relationships) - Create relation tuples from JSON files

39 changes: 39 additions & 0 deletions docs/cli/ory-delete-organization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: ory-delete-organization
title: ory delete organization
description: ory delete organization Delete the organization with the given ID
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory delete organization

Delete the organization with the given ID

```
ory delete organization id [--project=PROJECT_ID] [flags]
```

### Options

```
-h, --help help for organization
--project string The project to use, either project ID or a (partial) slug.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
--format string Set the output format. One of default, json, yaml, json-pretty and jsonpath. (default "default")
-q, --quiet Be quiet with output printing.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory delete](ory-delete) - Delete resources

1 change: 1 addition & 0 deletions docs/cli/ory-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ Delete resources
* [ory delete identity](ory-delete-identity) - Delete one or more identities by their ID(s)
* [ory delete jwk](ory-delete-jwk) - Delete one or more JSON Web Key Sets by their set ID
* [ory delete oauth2-client](ory-delete-oauth2-client) - Delete one or more OAuth 2.0 Clients by their ID(s)
* [ory delete organization](ory-delete-organization) - Delete the organization with the given ID
* [ory delete relationships](ory-delete-relationships) - Delete ALL relation tuples matching the relation query.

39 changes: 39 additions & 0 deletions docs/cli/ory-list-organizations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: ory-list-organizations
title: ory list organizations
description: ory list organizations List your Ory Network organizations
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory list organizations

List your Ory Network organizations

```
ory list organizations [flags]
```

### Options

```
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for organizations
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory list](ory-list) - List resources

1 change: 1 addition & 0 deletions docs/cli/ory-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ List resources
* [ory](ory) - The ORY CLI
* [ory list identities](ory-list-identities) - List identities
* [ory list oauth2-clients](ory-list-oauth2-clients) - List OAuth 2.0 Clients
* [ory list organizations](ory-list-organizations) - List your Ory Network organizations
* [ory list projects](ory-list-projects) - List your Ory Network projects.
* [ory list relationships](ory-list-relationships) - List relation tuples

41 changes: 41 additions & 0 deletions docs/cli/ory-update-organization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: ory-update-organization
title: ory update organization
description: ory update organization Update the organization with the given ID
---

<!--
This file is auto-generated.
To improve this file please make your change against the appropriate "./cmd/*.go" file.
-->
## ory update organization

Update the organization with the given ID

```
ory update organization id [--project=PROJECT_ID] [--domains=a.example.com,b.example.com] [--label=LABEL] [flags]
```

### Options

```
-d, --domains strings A list of domains that will be used for this organization.
--format string Set the output format. One of table, json, yaml, json-pretty, and jsonpath. (default "default")
-h, --help help for organization
-l, --label string The label of the organization.
--project string The project to use, either project ID or a (partial) slug.
-q, --quiet Be quiet with output printing.
```

### Options inherited from parent commands

```
-c, --config string Path to the Ory Network configuration file.
-y, --yes Confirm all dialogs with yes.
```

### SEE ALSO

* [ory update](ory-update) - Update resources

1 change: 1 addition & 0 deletions docs/cli/ory-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Update resources
* [ory update oauth2-client](ory-update-oauth2-client) - Update an OAuth 2.0 Client
* [ory update oauth2-config](ory-update-oauth2-config) - Update the Ory OAuth2 & OpenID Connect configuration of the specified Ory Network project.
* [ory update opl](ory-update-opl) - Update the Ory Permission Language file in Ory Network
* [ory update organization](ory-update-organization) - Update the organization with the given ID
* [ory update permission-config](ory-update-permission-config) - Update Ory Permissions configuration of the specified Ory Network project.
* [ory update project](ory-update-project) - Update Ory Network project service configuration

0 comments on commit ba6fdc8

Please sign in to comment.