Authentication
| Operation | Description |
|---|---|
| GET /insightservices/rest/v1/auth/currentuser | currentUser |
| GET /insightservices/rest/v1/auth/currentuser/credentials | Get the ID created date of the REST API credentials for the current user |
| POST /insightservices/rest/v1/auth/currentuser/credentials | Generate new REST API credentials for the current user |
| DELETE /insightservices/rest/v1/auth/currentuser/credentials | Revoke the REST API credentials for the current user |
| POST /insightservices/rest/v1/auth/token | Generates a bearer token for the given client for use in an Authorization: Bearer
|
| GET /insightservices/rest/v1/auth/user | Get the bearer token details for the current user |
GET /insightservices/rest/v1/auth/currentuser
Responses
application/json
- 200 OK
-
Type: UserProfileV1
OK
GET /insightservices/rest/v1/auth/currentuser/credentials
Responses
application/json
- 200 OK
-
Type: RestApiCredentialsInfoV1
Responds with the ID created date of the REST API credentials for the current user
- 404 Not Found
-
The current user has no REST API credentials
POST /insightservices/rest/v1/auth/currentuser/credentials
Request Body
application/json
Responses
application/json
- 200 OK
-
Type: RestApiCredentialsV1
Responds with the newly generated REST API credentials for the current user
DELETE /insightservices/rest/v1/auth/currentuser/credentials
Responses
application/json
- 204 No Content
-
The REST API credentials for the current user have been revoked
POST /insightservices/rest/v1/auth/token
Request Body
application/json
Type: RestApiCredentialsForBearerTokenV1
the REST API credentials
Responses
application/json
- 200 OK
-
Responds with a new bearer token for the given client
GET /insightservices/rest/v1/auth/user
Responses
application/json
- 200 OK
-
Type: UserTokenInfoV1
Responds with the bearer token details for the current user
REST API credentials to generate a bearer token
Properties
- clientId: string
-
The ID of client
- maxAge: integer (int64)
-
The number of seconds until the generated token will expire
- secret: string
-
The secret used to authorize the client
Properties
- createdDate: integer (int64)
-
The date/time when these credentials were created
- credentialsId: integer (int64)
-
The ID of these credentials - incremented for each generation
Generated REST API credentials
Properties
- clientId: string
-
The ID of client
- createdDate: integer (int64)
-
The date/time when these credentials were created
- credentialsId: integer (int64)
-
The ID of these credentials - incremented for each generation
- secret: string
-
The secret used to authorize the client
Properties
- objectType: string , x ∈ { USER_PROFILE }
-
- id: string
-
The id of this user
Example: "8cf6406a-6e43-402b-95eb-c0a47f8791cc" - firstName: string
-
Example: "William" - lastName: string
-
Example: "Gates" - displayName: string
-
Example: "William Gates" - authorities: string[]
-
The authorities granted to this user
Array of string - url: string
-
The URL of this user
Example: "/insightservices/rest/v1/auth/currentuser" - email: string
-
- authorityGroups: string[]
-
The custom authorities granted to this user
Array of string - evaluationUser: boolean
-
Whether this is an evaluation user