Authorize

get

https://hermes-dev.zealid.com/api/v3.0/csc/v1/oauth2/authorize

Initiate an OAuth 2.0 authorization flow

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

scope

string

required

Defaults to scope

Must be set to “credential” or "service". First call must use "service" (login authorization), second call must use "credential" (signing authorization).

response_type

string

required

Defaults to code

The value SHALL be “code”.

client_id

string

required

Defaults to $client_id

The unique client_id previously assigned to the client by the remote service (ZealiD).

redirect_uri

string

Defaults to $redirect_uri

The URL where the user will be redirected after the authorization process has completed. Only a valid URI preregistered with the remote service (i.e. which starts with the base URL preregistered with ZealiD) SHALL be passed. If omitted, the remote service will use the default redirect URI pre-registered by the client.

state

string

Defaults to 12345678

Optional string (up to 255 characters) which will be passed back to client after eventual redirect to error or success page

account_token

string

Defaults to $account_token

REQUIRED CONDITIONAL field with scope "service". Account token generated according to CSC spec

numSignatures

int32

Defaults to 1

REQUIRED CONDITIONAL field with scope "credential". The number of signatures to authorize. Must be an integer matching the number of hashes.

hash

string

REQUIRED CONDITIONAL field with scope "credential". One or more base64url-encoded hash values to be signed. Multiple hash values can be passed as comma separated values, e.g. oauth2/authorize?hash=bjQLnP+zepicpUTmu3gKLHiQHT+zNzh2hRGjBhevoB0=,lqKW0iTyhcZ77pPDD4owkVfw2qNdxbh+QQt4YwoJz8c=,… (The parameter name is singular “hash” to match CSC spec).

credentialID

string

Defaults to $credential_id

REQUIRED CONDITIONAL field with scope "credential". The unique identifier associated to the credential. Returned in credentials/list.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

302302

400400