Open Source API Gateway

users

Version

Syntax

users:
apiKey: <string>
name: <string>
tokens: <int>
users:
  apiKey: <string>
  name: <string>
  tokens: <int>

Attributes

NameRequiredDefaultDescriptionExamples
apiKeyfalse-The api key the client sends to authenticate as this user. It is the key of the gateway, not the key of the provider, and it is required.abc123
namefalse-Name of the api user, group or cost center. Used to attribute the recorded usage.alice
tokensfalse0 (no limit)Number of tokens the user may spend within the current period. Input and the reserved output of a request count against it, and the period is set by limitResetPeriod of the store.10000

Can be used in