Hydra

Learn about actions >

• add-secret-key

  Adds a new secret key used by hydra to encrypt sensitive data

  Params

  • key string

    The key

  • type string

    The type of secret to fetch, allowed values are ["system", "cookie"]

• create-oauth-client

  Register an oauth client

  Params

  • audience array

    A list with the allowed audience for the client

  • client-secret string

    The client's secret, if not provided one will be autogenerated.

  • client-uri string

    The client's uri, usually its homepage

  • contacts array

    A list of contacts for the client

  • grant-types array

    A list with the allowed grant types for the client

  • metadata string

    A comma-separated string of <key>=<value> with extra information relevant for the client, eg dept=IT

  • name string

    A user-friendly name given to the client

  • redirect-uris array

    A list with the client's redirect_uri

  • response-types array

    A list with the allowed response types for the client

  • scope array

    A list with the allowed scopes for the client

  • token-endpoint-auth-method string

    The authentication method the client may use at the token endpoint.

• delete-oauth-client

  Delete an oauth client

  Params

  • client-id string

    The client_id

  Required

  client-id

• get-oauth-client-info

  Get an oauth client's information

  Params

  • client-id string

    The client_id

  Required

  client-id

• get-secret-keys

  Get all the system or cookie secret keys used by hydra to encrypt sensitive data

  Params

  • type string

    The type of secret to fetch, allowed values are ["system", "cookie"]

• list-oauth-clients

  List all oauth clients

• reconcile-oauth-clients

  Clean up clients that were created by the oauth relation

• revoke-oauth-client-access-tokens

  Delete an oauth client's access tokens

  Params

  • client-id string

    The client_id

  Required

  client-id

• rotate-key

  Rotate the jwk used for signing tokens

  Params

  • algorithm string

    The algorithm that should be used

• run-migration

  Run a migration, this is needed after upgrades. This is a non-reversible operation. Run this after backing up the database.

  Params

  • timeout number

    Timeout after which the migration will be canceled

• update-oauth-client

  Update an oauth client

  Params

  • audience array

    A list with the allowed audience for the client

  • client-id string

    The client_id

  • client-secret string

    The client's secret, if not provided one will be autogenerated.

  • client-uri string

    The client's uri, usually its homepage

  • contacts array

    A list of contacts for the client

  • grant-types array

    A list with the allowed grant types for the client

  • metadata

    A comma-separated string of <key>=<value> with extra information relevant for the client, eg dept=IT

  • name string

    A user-friendly name given to the client

  • redirect-uris array

    A list with the client's redirect_uri

  • response-types array

    A list with the allowed response types for the client

  • scope array

    A list with the allowed scopes for the client

  • token-endpoint-auth-method string

    The authentication method the client may use at the token endpoint.

  Required

  client-id