NOnomos
Authentication

Authorize

Changed on

Create an authorized session

get/oauth/authorize

Request

  • Base URL
    https://api.nomos.energy
  • URL
    https://api.nomos.energy/oauth/authorize
  • Auth
    none declared

Query parameters

response_type'code' required

The response type, must be 'code' for authorization code flow

Example:code
client_idstring required

The client identifier issued to the client during registration

Example:client_12345
redirect_uristring uri required

The URI to redirect to after authorization is complete

Example:https://your-app.com/callback
scopestring
statestring

Optional value used by the client to maintain state between request and callback

Example:xcoiv98sj3coijs
code_challengestring

PKCE code challenge derived from the code verifier

Example:E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
code_challenge_method'S256' | 'plain'

Method used to derive the code challenge, either 'S256' or 'plain'

Example:S256
flow_type'login' | 'signup'

If you want to use Nomos as identity provider, you can support a login or signup flow via explicitly setting this parameter. In contrast to the default, the login options skips the consent screen. The signup options allows your users to create a new customer without a subscription attached to it, and therefore register an account.

Example:login

Changes

  • ae823aac7088Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the custom enum value from the // response property for the response status

    • info

      removed the duplicate_customer_email enum value from the // response property for the response status

    • info

      removed the duplicate_grid_reduction enum value from the // response property for the response status

    • info

      removed the duplicate_meter_order enum value from the // response property for the response status

    • info

      removed the duplicate_meter_reading enum value from the // response property for the response status

    • info

      removed the ended_subscription enum value from the // response property for the response status

    • info

      removed the implausible_meter_reading enum value from the // response property for the response status

    • info

      removed the invalid_element enum value from the // response property for the response status

    • info

      removed the invalid_format enum value from the // response property for the response status

    • info

      removed the invalid_iban enum value from the // response property for the response status

    • info

      removed the invalid_key enum value from the // response property for the response status

    • info

      removed the invalid_termination_date enum value from the // response property for the response status

    • info

      removed the invalid_type enum value from the // response property for the response status

    • info

      removed the invalid_union enum value from the // response property for the response status

    • info

      removed the invalid_value enum value from the // response property for the response status

    • info

      removed the missing_module_1 enum value from the // response property for the response status

    • info

      removed the missing_smart_meter enum value from the // response property for the response status

    • info

      removed the not_multiple_of enum value from the // response property for the response status

    • info

      removed the out_of_period_meter_reading enum value from the // response property for the response status

    • info

      removed the subscription_not_started enum value from the // response property for the response status

    • info

      removed the too_big enum value from the // response property for the response status

    • info

      removed the too_small enum value from the // response property for the response status

    • info

      removed the unrecognized_keys enum value from the // response property for the response status

    • info

      removed the unserviceable_zip enum value from the // response property for the response status

    • info

      removed the unsupported_meter enum value from the // response property for the response status

    • info

      removed the unsupported_meter_order enum value from the // response property for the response status

    • info

      removed the unsupported_meter_reading enum value from the // response property for the response status

    • info

      removed the unsupported_product enum value from the // response property for the response status

    • info

      removed the upgrade_api_version enum value from the // response property for the response status

    • info

      removed the withdrawal_not_allowed enum value from the // response property for the response status