/oauth/token
Relative path: /oauth/token
Base URL for Europe, Germany, United States, Canada and Japan regions:
|
https://eu.business-account.iam.eset.systems |
|
https://de.business-account.iam.eset.systems |
|
https://us.business-account.iam.eset.systems |
|
https://ca.business-account.iam.eset.systems |
|
https://jpn.business-account.iam.eset.systems |
Request body
Display Schema instead of an Example or vice-versa
Type |
Required |
Example |
Schema |
|---|---|---|---|
application/x-www-form-urlencoded |
Yes |
{
"grant_type": "password",
"username": "string",
"password": "string",
"refresh_token": "string"
} |
{
"$ref": "oauth_token_body",
"grant_type": {
"type": "string",
"description": "Value MUST be set to password or refresh_token as per RFC.",
"enum": [
"password",
"refresh_token"
]
},
"username": {
"type": "string",
"description": "Value MUST be set when granting password"
},
"password": {
"type": "string",
"description": "Value MUST be set when granting password",
"format": "password"
},
"refresh_token": {
"type": "string",
"description": "Value MUST be set when granting refresh_token"
}
} |
Responses
Display Schema+Headers instead of an Example or vice-versa
Code |
Description and Example |
Description, Schema and Headers |
|---|---|---|
200 |
Authorisation token (Bearer)
{
"access_token": "string",
"refresh_token": "string",
"token_type": "Bearer",
"expires_in": 0
}
|
Authorisation token (Bearer)
{
"$ref": "Token",
"access_token": {
"type": "string",
"description": "The access token value"
},
"refresh_token": {
"type": "string",
"description": "The refresh token value"
},
"token_type": {
"type": "string",
"description": "Type of the token is set to 'Bearer'",
"enum": [
"Bearer"
]
},
"expires_in": {
"type": "integer",
"description": "The lifetime in seconds of the access token",
"format": "int32"
}
}
{
"request-id": {
"description": "Unique ID of the request.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
default |
An unexpected error response. |
An unexpected error response.
[]
{
"request-id": {
"description": "Unique ID of the request.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|
202 |
Response took too long and the request was cached. |
Response took too long and the request was cached.
[]
{
"response-id": {
"description": "Unique ID of a pending request. Used to retrieve cached result.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
"request-id": {
"description": "Unique ID of the request.",
"style": "simple",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
}
}
|