POST OAuth/GetRole
Returns the caller's OAuth role.
Authorization
- Roles: Any
- Token scope: Admin
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
None
Returns
Name |
Description |
---|---|
HTTP 200 |
See OAuth result codes and OAuth roles. A Role object is returned with the following:
|
HTTP 400 |
For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:
|
HTTP 401 |
For authentication errors, this call returns HTTP 401 Unauthorized and the following data in the message body:
|
HTTP 403 |
If the response is HTTP 403 Forbidden, the requester's token does not include the admin scope. Call POST Authorize/OAuth with the correct scope and restriction. Update the header with the new token and retry.
|
Example
Request
POST /vedsdk/oauth/getrole HTTP/1.1 Host: tpp-server-url Content-Type: application/json Accept: application/json Authorization: Bearer 4MyGeneratedBearerTknz== {
}
Owner/Maintainer response
In this example, role 4 is shown because the caller has role 2 for one application and role 3 for another. As a result, the caller's role is role 4--Mixed Owner/Maintainer.
{ "Result": 0, "Role": { "OwnedApplications": [ { "ApplicationId": "Application-1", "Role": 2 }, { "ApplicationId": "Application-2", "Role": 3 } ], "PermittedApplications": [ "Application-1", "Application-2" ], "Role": 4 }, "Success": true }
Global role response
{ "Result": 0, "Role": { "Role": 6 }, "Success": true }