-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
1,269 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
id: hydra-clients-create | ||
title: hydra clients create | ||
description: hydra clients create Create a new OAuth 2.0 Client | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra clients create | ||
|
||
Create a new OAuth 2.0 Client | ||
|
||
### Synopsis | ||
|
||
This command creates an OAuth 2.0 Client which can be used to perform various OAuth 2.0 Flows like | ||
the Authorize Code, Implicit, Refresh flow. | ||
|
||
ORY Hydra implements the OpenID Connect Dynamic Client registration specification. Most flags are supported by this command | ||
as well. | ||
|
||
Example: | ||
hydra clients create -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar | ||
|
||
To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example: | ||
hydra clients create -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username | ||
|
||
|
||
``` | ||
hydra clients create [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--allowed-cors-origins strings The list of URLs allowed to make CORS requests. Requires CORS_ENABLED. | ||
--audience strings The audience this client is allowed to request | ||
-c, --callbacks strings REQUIRED list of allowed callback URLs | ||
--client-uri string A URL string of a web page providing information about the client | ||
-g, --grant-types strings A list of allowed grant types (default [authorization_code]) | ||
-h, --help help for create | ||
--id string Give the client this id | ||
--jwks-uri string Define the URL where the JSON Web Key Set should be fetched from when performing the "private_key_jwt" client authentication method | ||
--keybase string Keybase username for encrypting client secret | ||
--logo-uri string A URL string that references a logo for the client | ||
-n, --name string The client's name | ||
--pgp-key string Base64 encoded PGP encryption key for encrypting client secret | ||
--pgp-key-url string PGP encryption key URL for encrypting client secret | ||
--policy-uri string A URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data | ||
--post-logout-callbacks strings List of allowed URLs to be redirected to after a logout | ||
-r, --response-types strings A list of allowed response types (default [code]) | ||
-a, --scope strings The scope the client is allowed to request | ||
--secret string Provide the client's secret | ||
--subject-type string A identifier algorithm. Valid values are "public" and "pairwise" (default "public") | ||
--token-endpoint-auth-method string Define which authentication method the client may use at the Token Endpoint. Valid values are "client_secret_post", "client_secret_basic", "private_key_jwt", and "none" (default "client_secret_basic") | ||
--tos-uri string A URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL. A unix socket can be set in the form unix:///path/to/socket | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination Fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
id: hydra-clients-delete | ||
title: hydra clients delete | ||
description: hydra clients delete Delete an OAuth 2.0 Client | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra clients delete | ||
|
||
Delete an OAuth 2.0 Client | ||
|
||
### Synopsis | ||
|
||
This command deletes one or more OAuth 2.0 Clients by their respective IDs. | ||
|
||
Example: | ||
hydra clients delete client-1 client-2 client-3 | ||
|
||
``` | ||
hydra clients delete <id> [<id>...] [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for delete | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL. A unix socket can be set in the form unix:///path/to/socket | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination Fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
id: hydra-clients-get | ||
title: hydra clients get | ||
description: hydra clients get Get an OAuth 2.0 Client | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra clients get | ||
|
||
Get an OAuth 2.0 Client | ||
|
||
### Synopsis | ||
|
||
This command retrieves an OAuth 2.0 Clients by its ID. | ||
|
||
Example: | ||
hydra clients get client-1 | ||
|
||
``` | ||
hydra clients get <id> [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for get | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL. A unix socket can be set in the form unix:///path/to/socket | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination Fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
id: hydra-clients-import | ||
title: hydra clients import | ||
description: hydra clients import Import OAuth 2.0 Clients from one or more JSON files | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra clients import | ||
|
||
Import OAuth 2.0 Clients from one or more JSON files | ||
|
||
### Synopsis | ||
|
||
This command reads in each listed JSON file and imports their contents as OAuth 2.0 Clients. | ||
|
||
The format for the JSON file is: | ||
|
||
{ | ||
"client_id": "...", | ||
"client_secret": "...", | ||
// ... all other fields of the OAuth 2.0 Client model are allowed here | ||
} | ||
|
||
Please be aware that this command does not update existing clients. If the client exists already, this command will fail. | ||
|
||
Example: | ||
hydra clients import client-1.json | ||
|
||
To encrypt auto generated client secret, use "--pgp-key", "--pgp-key-url" or "--keybase" flag, for example: | ||
hydra clients import client-1.json --keybase keybase_username | ||
|
||
|
||
``` | ||
hydra clients import <path/to/file.json> [<path/to/other/file.json>...] [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for import | ||
--keybase string Keybase username for encrypting client secret | ||
--pgp-key string Base64 encoded PGP encryption key for encrypting client secret | ||
--pgp-key-url string PGP encryption key URL for encrypting client secret | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL. A unix socket can be set in the form unix:///path/to/socket | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination Fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
id: hydra-clients-list | ||
title: hydra clients list | ||
description: hydra clients list List OAuth 2.0 Clients | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra clients list | ||
|
||
List OAuth 2.0 Clients | ||
|
||
### Synopsis | ||
|
||
This command list an OAuth 2.0 Clients. | ||
|
||
Example: | ||
hydra clients list | ||
|
||
``` | ||
hydra clients list [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for list | ||
--limit int The maximum amount of policies returned. (default 20) | ||
--page int The number of page. (default 1) | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL. A unix socket can be set in the form unix:///path/to/socket | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination Fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra clients](hydra-clients) - Manage OAuth 2.0 Clients | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
id: hydra-clients | ||
title: hydra clients | ||
description: hydra clients Manage OAuth 2.0 Clients | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra clients | ||
|
||
Manage OAuth 2.0 Clients | ||
|
||
### Synopsis | ||
|
||
Manage OAuth 2.0 Clients | ||
|
||
### Options | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL. A unix socket can be set in the form unix:///path/to/socket | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination Fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
-h, --help help for clients | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra](hydra) - Run and manage ORY Hydra | ||
* [hydra clients create](hydra-clients-create) - Create a new OAuth 2.0 Client | ||
* [hydra clients delete](hydra-clients-delete) - Delete an OAuth 2.0 Client | ||
* [hydra clients get](hydra-clients-get) - Get an OAuth 2.0 Client | ||
* [hydra clients import](hydra-clients-import) - Import OAuth 2.0 Clients from one or more JSON files | ||
* [hydra clients list](hydra-clients-list) - List OAuth 2.0 Clients | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
id: hydra-keys-create | ||
title: hydra keys create | ||
description: hydra keys create Create a new JSON Web Key Set | ||
--- | ||
|
||
<!-- | ||
This file is auto-generated. | ||
To improve this file please make your change against the appropriate "./cmd/*.go" file. | ||
--> | ||
## hydra keys create | ||
|
||
Create a new JSON Web Key Set | ||
|
||
### Synopsis | ||
|
||
Create a new JSON Web Key Set | ||
|
||
``` | ||
hydra keys create <set> <key> [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-a, --alg string The algorithm to be used to generated they key. Supports: RS256, ES512, HS256 (default "RS256") | ||
-h, --help help for create | ||
-u, --use string The intended use of this key (default "sig") | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--access-token string Set an access token to be used in the Authorization header, defaults to environment variable OAUTH2_ACCESS_TOKEN | ||
--config string Config file (default is $HOME/.hydra.yaml) | ||
--endpoint string Set the URL where ORY Hydra is hosted, defaults to environment variable HYDRA_ADMIN_URL | ||
--fail-after duration Stop retrying after the specified duration (default 1m0s) | ||
--fake-tls-termination fake tls termination by adding "X-Forwarded-Proto: https" to http headers | ||
--skip-tls-verify Foolishly accept TLS certificates signed by unkown certificate authorities | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [hydra keys](hydra-keys) - Manage JSON Web Keys | ||
|
Oops, something went wrong.