Konnect regional consumers auth api (dev)
realms
realms
Get a realm
get
Path Parameters
realmIdstring(uuid)required
ID of the realm
Response
application/json
Response
application/json
success
AuthConsumerRealm
idstringrequired
namestringrequired
ttlintegerrequired
negative_ttlintegerrequired
consumer_groupsarray[string]requiredunique-items
A list of consumer groups that the Consumer is in.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
get/{realmId}/v1
Path Parameters
application/json
Authenticate on this realm
post
Path Parameters
realmIdstring(uuid)required
ID of the realm
Body
application/json
Body
application/json
AuthenticateBody
secretstringrequired
metaobject
Default:{}
Response
application/json
Response
application/json
success
AuthenticateResponseBody
idstringrequired
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
usernamestringrequired
custom_idstringrequired
typestringrequired
tagsarray[string]requiredunique-items
username_lowerstringrequired
ttlintegerrequired
negative_ttlintegerrequired
consumer_group_namesarray[string]required
credentialobject
Show Child Parameters
metaobjectrequired
post/{realmId}/v1/authenticate
Path Parameters
Body
{
"secret": "secret"
}
application/json
AuthConsumerRealm
objectidstringrequired
namestringrequired
ttlintegerrequired
negative_ttlintegerrequired
consumer_groupsarray[string]requiredunique-items
A list of consumer groups that the Consumer is in.
If consumer_groups are provided on the Consumer object and on the Realm, the Consumer will be placed in all defined consumer groups.
Example
AuthenticateBody
objectsecretstringrequired
metaobject
Default:{}
Example