|
| 1 | +--- |
| 2 | +id: ory-perform-device-code |
| 3 | +title: ory perform device-code |
| 4 | +description: ory perform device-code |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- |
| 8 | +This file is auto-generated. |
| 9 | +
|
| 10 | +To improve this file please make your change against the appropriate "./cmd/*.go" file. |
| 11 | +--> |
| 12 | +## ory perform device-code |
| 13 | + |
| 14 | +Example OAuth 2.0 Client performing the OAuth 2.0 Device Code Flow |
| 15 | + |
| 16 | +### Synopsis |
| 17 | + |
| 18 | +Performs the device code flow. Useful for getting an access token and an ID token in machines without a browser. |
| 19 | +The client that will be used MUST use the "none" or "client_secret_post" token-endpoint-auth-method. |
| 20 | + |
| 21 | +``` |
| 22 | +ory perform device-code [flags] |
| 23 | +``` |
| 24 | + |
| 25 | +### Examples |
| 26 | + |
| 27 | +``` |
| 28 | +ory perform device-code --client-id ... |
| 29 | +``` |
| 30 | + |
| 31 | +### Options |
| 32 | + |
| 33 | +``` |
| 34 | + --audience strings Request a specific OAuth 2.0 Access Token Audience |
| 35 | + --client-id string Use the provided OAuth 2.0 Client ID, defaults to environment variable OAUTH2_CLIENT_ID |
| 36 | + --client-secret string Use the provided OAuth 2.0 Client Secret, defaults to environment variable OAUTH2_CLIENT_SECRET |
| 37 | + --device-auth-url endpoint Usually it is enough to specify the endpoint flag, but if you want to force the device authorization url, use this flag |
| 38 | + -e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable. |
| 39 | + --format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "table") |
| 40 | + -h, --help help for device-code |
| 41 | + -p, --port urls.device.verification Set this to a port number to start a local server that will serve the device authorization page. You need to configure Hydra's urls.device.verification to point to `http://127.0.0.1:<PORT>/device` in this mode. (default -1) |
| 42 | + --project string The project to use, either project ID or a (partial) slug. |
| 43 | + -q, --quiet Be quiet with output printing. |
| 44 | + --scope strings Request OAuth2 scope (default [offline,openid]) |
| 45 | + --token-url endpoint Usually it is enough to specify the endpoint flag, but if you want to force the token url, use this flag |
| 46 | + --workspace string The workspace to use, either workspace ID or a (partial) name. |
| 47 | +``` |
| 48 | + |
| 49 | +### Options inherited from parent commands |
| 50 | + |
| 51 | +``` |
| 52 | + -c, --config string Path to the Ory Network configuration file. |
| 53 | + -y, --yes Confirm all dialogs with yes. |
| 54 | +``` |
| 55 | + |
| 56 | +### See also |
| 57 | + |
| 58 | +* [ory perform](ory-perform) Perform a flow |
| 59 | + |
0 commit comments