Authentication resources
Operation | Description |
---|---|
GET /api/authentication/current-user | Get the logged-in user |
GET /api/authentication/token | Get bearer token details |
POST /api/authentication/token | Generate a bearer token |
GET /api/authentication/current-user
Get your user details.
Responses
- 200 OK
-
The logged-in user details
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
GET /api/authentication/token
Get the bearer token details for the current user.
Responses
- 200 OK
-
The bearer token details for the current user
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
POST /api/authentication/token
Generate a bearer token for the provided client for use in an Authorization: Bearer <token> header
Request Body
The REST API credentials
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
Responses
- 200 OK
-
A new bearer token for the provided client ID
- Content-Type application/vnd.com.fico.xpress.insight.v2+json
-
string
- Content-Type text/plain
-
string
Information about a bearer token
Properties
- access_token_expiration_time: string
-
The expiration time of the token
- cn: string
-
The user's common name
- mail: string
-
The user's email address
- uid: string (uuid)
-
The user ID
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
The basic details of an authority group
Properties
- id: string (uuid)
-
The ID of this authority group
Example: "e41f940c-f974-b034-1be0-6bf33086fd89"
- name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$
-
The name of this authority group
Example: "My authority group"
- objectType: string , one of { AUTHORITY_GROUP }
-
- url: string (uri)
-
The URL of this authority group
Example: "/api/admin/authority-groups/e41f940c-f974-b034-1be0-6bf33086fd89"
Properties
- id: string (uuid)
-
The ID of this execution service
Example: "8aadc318-75b3-3bee-7552-3ce8030b27c4"
- name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$
-
The name of this execution service
Example: "My execution service"
- objectType: string , one of { EXECUTION_SERVICE }
-
- url: string (uri)
-
The URL of this execution service
Example: "/api/admin/execution/services/8aadc318-75b3-3bee-7552-3ce8030b27c4"
Information about a user
Properties
- authorities: string[]
-
The authorities granted to this user
Array of string - authorityGroups: object[]
-
The authority groups granted to this user
Array of ReferenceAuthorityGroup - email: string
-
The email address of this user
- executionServices: object[]
-
Restricted execution services that the user has access to
Array of ReferenceExecutionService - firstName: string
-
This user's first name
Example: "William"
- id: string (uuid)
-
The ID of this user profile
Example: "dde8c708-46f5-4732-2217-38f7ea4813b9"
- lastName: string
-
This user's last name
Example: "Sweet"
- name: string (1 to 255 chars) , must match ^[^\p{Cntrl}]*$ & ^\S(?:[\s\S]*\S)?$
-
The name of this user
Example: "William Sweet"
- objectType: string , one of { USER_PROFILE }
-
- url: string (uri)
-
The URL of this user profile
Example: "/api/authentication/current-user"
© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.