Skip to main content
The Authentication API issues the OAuth2 access tokens used to call Hellgate Cloud Platform services. You exchange a client ID and client secret for a token using the client-credentials grant, then send the token as a bearer token on each request.

​
Token endpoint

The token endpoint is hosted at https://auth.eu1.hellgate.cloud.

​
Authentication

Send your client ID and client secret to the token endpoint using HTTP Basic authentication. The Request an access token operation describes the request and response in full. Tokens are scoped to an audience — the service instance they may call — and carry the scopes that gate individual endpoints. The audience and scope parameters are both required on every token request; there are no defaults, and each must fall within the limits provisioned on your client. For how a specific product validates the token and which scopes and audience it requires, see that product’s access guide — for example, Specter Authentication.

​
Data Classification

Fields that carry regulated data are marked with a classification pill next to the parameter name in this reference. The marker tells you what kind of data the field holds, so you can see at a glance which parts of a payload attract handling obligations before you write any code against them. Most fields carry no marker at all. The absence of one is a statement that the field holds none of the categories above — not that the field has yet to be reviewed. Masked and truncated card numbers are the common example: 411111 •••••• 1111 identifies nobody on its own, so it carries no marker. The marker is also a gate, not just a label. Sending values into pci-pan or pci-sad fields requires your PCI DSS certification on file at SAQ-D or a full Report on Compliance (RoC). Sending personal data into pii fields requires a data processing agreement (DPA) between us. Contact support@hellgate.io to put either in place or to learn more. The same markers are used on the other Hellgate Cloud Platform references that carry them, so a marker means the same thing wherever you meet it.