Get User Data
Describes the API specifications for retrieving all user data.
Request
URI: https://<SAP Fieldglass envionment URL>/api/v1/admin/v1/users/<userID>?_loadInActive=true
HTTP Method: GET
Request Parameters
| Parameter | Required | Data Type | Description | Parameter Type |
|---|---|---|---|---|
| userID | Yes | String | The unique ID of the user. | Path |
| _loadInActive=true | No | String | Include a record that is inactive but should still be pulled into the API. | Query String |
Request Example
GET https://company.com/api/v1/admin/v1/users/012504042014411759438076 authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1= x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350 content-type: application/json
Response
Response Status and Error Codes
See Common Status and Error Codes for more information.
Response Body
| Element | Data Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accessToAllBu | String | Indicates whether the user has access to all business units. | ||||||||||||
| accessToAllCostCenter | String | Indicates whether the user has access to all cost centers. | ||||||||||||
| accessToAllSite | String | Indicates whether the user has access to all sites. | ||||||||||||
| accessToPmoFlag | Boolean | Indicates whether the user has access to PMO assisted work flow for job postings. | ||||||||||||
| accessToVisualizerFlag | Boolean | Indicates whether the user has access to Visualizer. | ||||||||||||
| activeFlag | Boolean | Indicates whether the user is active. | ||||||||||||
| address1 | String | The user's address, Line 1. | ||||||||||||
| allowLinksToMyAccountFlag | Boolean | Indicates whether other accounts can be linked to the user's account. | ||||||||||||
| authSupportContactFlag | Boolean | Indicates whether the user is authorized to contact the SAP Fieldglass Support Team. | ||||||||||||
| botsType | Number | |||||||||||||
| buId | String | The Business Unit ID as defined in the SAP Fieldglass system. | ||||||||||||
| canElectronicallySignContract | Boolean | Indicates whether the user is authorized to electronically sign contracts. | ||||||||||||
| canRequestInterviewFlag | Boolean | Indicates whether the user can request Interviews from supplier. | ||||||||||||
| canSetRunAsUserFlag | Boolean | Indicates whether the user is allowed to set the 'Run as User' option. | ||||||||||||
| canSubmitQuickJpFlag | Boolean | Indicates whether the user can submit Quick Job Postings. | ||||||||||||
| canSubmitQuickRfxFlag | Boolean | Indicates whether the user can submit Quick RFXs. | ||||||||||||
| ccEmail | String | Address where a copy of emails are sent to. | ||||||||||||
| city | String | The user's city. | ||||||||||||
| cityCode | String | The code representing the city and | ||||||||||||
| companyCode | String | The user's company code. | ||||||||||||
| country | String | The user’s county. | ||||||||||||
| createTime | String | The date and time the user's record was created. | ||||||||||||
| customFieldSet | Array |
An array of custom fields.
|
||||||||||||
| deleteFlag | Boolean | Indicates whether the user was deleted. | ||||||||||||
| deviceId | String | |||||||||||||
| displayName | String | The user's display name. | ||||||||||||
| String | The user's email address. | |||||||||||||
| emailAlertFlag | Boolean | Indicates whether the user would like to receive email of the alerts or not at all. | ||||||||||||
| emailBroadcastFlag | Boolean | Indicates whether the user would like to receive broadcast message as an email or not at all. | ||||||||||||
| emailChatFlag | Boolean | Indicates whether chat messages for contingent documents will be sent to user as emails in addition to displayed in the application. If set to false, chat messages will only appear in the application and user will not be notified via email when they arrive. | ||||||||||||
| emailChatServicesFlag | Boolean | Indicates whether chat messages for services documents will be sent to user as emails in addition to displayed in the application. If set to false, chat messages will only appear in the application and user will not be notified via email when they arrive. | ||||||||||||
| emailNotificationFlag | Boolean | Indicates whether notifications will be sent to the user via email. | ||||||||||||
| emailStarFlag | Boolean | Indicates whether notifications of items being starred will be sent via email to the user. If set to false no notifications will be sent when starring occurs. | ||||||||||||
| emailWorkItemFlag | Boolean | Indicates whether the user would like to receive a Work Item as an email. | ||||||||||||
| fgUserFlag | Boolean | Indicates whether the user is an internal Fieldglass user. | ||||||||||||
| firstName | String | The first name of the user. | ||||||||||||
| hasAttachmentFlag | Boolean | |||||||||||||
| hasRegisteredThruUiFlag | Boolean | Indicates whether the user registered through the UI. | ||||||||||||
| lastDigestFlag | Boolean | The time the last digest is sent to the user. | ||||||||||||
| lastLoginTime | String | The date and time the user last logged in. | ||||||||||||
| lastName | String | The last name of the user. | ||||||||||||
| loginAuthType | String | Specifies the user's login authorization type. | ||||||||||||
| loginPasswordAuthenticationFlag | Boolean | Indicates whether the user uses login and password for authentication. | ||||||||||||
| loginSingleSignOnAuthenticationFlag | Boolean | Indicates whether the user uses single sign on for authentication. | ||||||||||||
| manageSiteConfigurationsFlag | Boolean | Indicates whether the user can edit site configurations. | ||||||||||||
| mspCoordinatorFlag | Boolean | Indicates whether the user may be assigned as a Coordinator and/or Distributor for a business unit. | ||||||||||||
| mspUserFlag | Boolean | Indicates whether the user belongs to an MSP company. | ||||||||||||
| needAssistWithInterviewCreationFlag | Boolean | Indicates whether the user can submit Interviews/Meetings to supplier. | ||||||||||||
| parentUserRoleId | String | |||||||||||||
| personId | String | The user's auto generated system ID. | ||||||||||||
| pinType | Sring | |||||||||||||
| postalCode | String | The user's postal code. | ||||||||||||
| prefCalendarStartDay | String | Specifies the first day of the week in the calendar widgets that pop up next to date fields in the application. | ||||||||||||
| prefColorTheme | String | The user's preferred UI color theme. | ||||||||||||
| prefCurrency | String | The user's preferred currency. Values may only consist of currencies already associated with the buyer. | ||||||||||||
| prefDateFormat | String | The user's preferred date format. | ||||||||||||
| prefEmailFormat | String |
Indicates the users preferred email format.
|
||||||||||||
| prefLanguage | String | The user's preferred language. | ||||||||||||
| prefNumberFormat | String | The user's preferred number format. | ||||||||||||
| prefShowHomePageAnnouncement | Boolean | Indicates whether the user wants to see the home page announcement. | ||||||||||||
| prefTimeFormat | String | The user's preferred time format. | ||||||||||||
| prefTimeZone | String | The user's preferred time zone. | ||||||||||||
| primaryBusinessUnitId | String | The ID of the user's business unit. | ||||||||||||
| primarySupervisorId | String | The SAP Fieldglass auto generated ID of the user's primary supervisor from the buyer side, which is used for escalation and notifications. IDs are defined in the SAP Fieldglass system.. | ||||||||||||
| receiveNotificationsBeforeRegistrationFlag | Boolean | Indicates whether the user receives notifications or work items via email before registration. | ||||||||||||
| reportOnLinkedSuppliersFlag | Boolean | |||||||||||||
| revisionTime | String | |||||||||||||
| roleId | String | The ID of the user's role. | ||||||||||||
| roleName | String | The user role as defined in the SAP Fieldglass system. | ||||||||||||
| sapDataNetworkUserType | String | |||||||||||||
| securityQuestionAnswer | String | The user specified answer to the security question. | ||||||||||||
| securityQuestionId | String | The ID of the user's selected security question. | ||||||||||||
| sendEmailApprovalFlag | Boolean | |||||||||||||
| sendNotificationDigestFlag | Boolean | Indicates whether the user wishes to receive notifications at a scheduled time. | ||||||||||||
| sendWorkItemDigestFlag | Boolean | Indicates whether the user wishes to receive work items at scheduled time. | ||||||||||||
| setRunAsUserFlag | Boolean | Indicates whether the user can run reports as another user. | ||||||||||||
| starredEmailFlag | Boolean | |||||||||||||
| stateProvince | Sting | The user's state or province. | ||||||||||||
| status | String | |||||||||||||
| supervisors | Array | Any defined supervisor list associated with the user. | ||||||||||||
| unregisterFlag | Boolean | |||||||||||||
| uploadedFlag | Boolean | |||||||||||||
| usePmoDashboardFlag | Boolean | Indicates whether the user will utilize the PMO Dashboard. | ||||||||||||
| useSourcingGuidance | Boolean | Indicates whether the user is allowed to use Flexible Sourcing to compare rate information for different sites and suppliers before creating a job posting. | ||||||||||||
| userAccessTypeForBusinessUnits | String |
Determines the method for which business unit access will be given to a user. ALL = All business units will be associated with the user. Build = As business units are used by users that are subordinate to the user or appear on transactions requiring the user’s approval, the user will be given access. Associate = Business units must be explicitly associated with the user on their profile in SAP Fieldglass. |
||||||||||||
| userAccessTypeForCostCenters | String |
Determines the method for which cost center access will be given to a user. ALL = All cost centers will be associated with the user. Build = As cost centers are used by users that are subordinate to the user or appear on transactions requiring the user’s approval, the user will be given access. Associate = Cost centers must be explicitly associated with the user on their profile in SAP Fieldglass. |
||||||||||||
| userAccessTypeForSites | String |
Determines the method for which sites access will be given to a user. ALL = All sites will be associated with the user. Build = As sites are used by users that are subordinate to the user or appear on transactions requiring the user’s approval, the user will be given access. Associate = Sites must be explicitly associated with the user on their profile in SAP Fieldglass. |
||||||||||||
| userType | Number | |||||||||||||
| username | String | The user's SAP Fieldglass user name. | ||||||||||||
| usersHaveAccessToAllDivisionCodeFlag | Boolean | Indicates whether the user has access to all of the division codes (Legal Entities). | ||||||||||||
| viewAndReportOnSensitiveDataFlag | Boolean | Indicates whether the user can see unencrypted values for Security ID and sensitive data for custom fields. | ||||||||||||
| viewHistoryTabFlag | Boolean | Indicates whether the changed fields display in the history tab when the user is creating or viewing a document. | ||||||||||||
| viewReleaseFeatureAdminFlag | Boolean | Indicates whether the user can view documentation for buyer administrators on the SAP Fieldglass product page on the SAP Help Portal. | ||||||||||||
| viewRestrictedAttachmentFlag | Boolean | Indicates whether the user can view restricted attachments. | ||||||||||||
| viewWorkerPersonalDetailsFlag | Boolean | Indicates whether the user can see worker personal details. |
| Element Name | Data Type | Description |
|---|---|---|
| rel | String |
Related sub-modules. Example:
|
| link | String | The URI of the link. |
| id | String | Globally unique database-level identifier of the user record. Only valid when rel=self. |
Response Example
{
"header": {
"server": "Fieldglass API Server",
"responseStatus": "OK",
"noOfRecordsPresent": 1,
"noOfRecordsServed": 1,
"moreRecordsExists": false,
"localeString": "en_US",
"version": "v1"
},
"responsePayload": {
"content": {
"accessToAllBu": "ALL",
"accessToAllCostCenter": "ALL",
"accessToAllSite": "ALL",
"accessToPmoFlag": true,
"accessToVisualizerFlag": false,
"activeFlag": true,
"address1": "SDSDSD",
"allowLinksToMyAccountFlag": true,
"authSupportContactFlag": false,
"botsType": 0,
"buId": "012504042014411764438082",
"canElectronicallySignContract": false,
"canRequestInterviewFlag": false,
"canSetRunAsUserFlag": true,
"canSubmitQuickJpFlag": true,
"canSubmitQuickRfxFlag": false,
"ccEmail": "fg_qatest8@sap.com",
"city": "Naperville, Illinois, United States",
"cityCode": "city.USA_NPV_IL",
"companyCode": "ANTE",
"country": "USA",
"createTime": "04/20/2004 09:41",
"customFieldSet": [
{
"id": "z05072607085103174760125",
"name": "",
"value": ""
},
{
"id": "z16061307163072565180983",
"name": "",
"value": ""
},
{
"id": "z16061304430343431109983",
"name": "",
"value": ""
},
{
"id": "z16061307153142153491983",
"name": "",
"value": ""
},
{
"id": "z18070913464730604619983",
"name": "",
"value": ""
}
],
"deleteFlag": false,
"deviceId": "VIRguNvKc3lle8pNVH8uZRDO9cX5pY8nRqhNBJ6cbik=::1195",
"displayName": "Dewherst, Susan (fg_qatest8@sap.com)",
"email": "vadim.belov@sap.com",
"emailAlertFlag": false,
"emailBroadcastFlag": false,
"emailChatFlag": false,
"emailChatServicesFlag": false,
"emailNotificationFlag": false,
"emailStarFlag": false,
"emailWorkItemFlag": false,
"fgUserFlag": false,
"firstName": "Susan",
"hasAttachmentFlag": false,
"hasRegisteredThruUiFlag": true,
"lastDigestFlag": false,
"lastLoginTime": "06/25/2021 07:13",
"lastName": "Dewherst",
"loginAuthType": "Both",
"loginPasswordAuthenticationFlag": true,
"loginSingleSignOnAuthenticationFlag": true,
"manageSiteConfigurationsFlag": true,
"mspCoordinatorFlag": false,
"mspUserFlag": false,
"needAssistWithInterviewCreationFlag": false,
"parentUserRoleId": "0",
"personId": "012504042014411759438076",
"pinType": "0",
"postalCode": "60148",
"prefCalendarStartDay": "Friday",
"prefColorTheme": "fiori3",
"prefCurrency": "USD",
"prefDateFormat": "MM/dd/yyyy",
"prefEmailFormat": "1",
"prefLanguage": "en_US",
"prefNumberFormat": "en_US",
"prefShowHomePageAnnouncement": false,
"prefTimeFormat": "HH:mm",
"prefTimeZone": "US/Central",
"primaryBusinessUnitId": "012504042014411764438082",
"primarySupervisorId": "z0608220427085836881812b",
"receiveNotificationsBeforeRegistrationFlag": true,
"reportOnLinkedSuppliersFlag": false,
"revisionTime": "06/23/2021 08:58",
"roleId": "5",
"roleName": "Administrator",
"sapDataNetworkUserType": "0",
"securityQuestionAnswer": "aes@u1AaaSMESXHZ0e2RIviek6lQlUjnwtds+6lhjLJKmSQ=",
"securityQuestionId": "QUESTION.PETSNAME",
"sendEmailApprovalFlag": false,
"sendNotificationDigestFlag": true,
"sendWorkItemDigestFlag": true,
"setRunAsUserFlag": true,
"starredEmailFlag": false,
"stateProvince": "IL",
"status": "Open",
"supervisors": [],
"unregisterFlag": false,
"uploadedFlag": true,
"usePmoDashboardFlag": true,
"useSourcingGuidance": false,
"userAccessTypeForBusinessUnits": "All",
"userAccessTypeForCostCenters": "All",
"userAccessTypeForSites": "All",
"userType": "Buyer",
"username": "Manthem",
"usersHaveAccessToAllDivisionCodeFlag": false,
"viewAndReportOnSensitiveDataFlag": false,
"viewHistoryTabFlag": false,
"viewReleaseFeatureAdminFlag": false,
"viewRestrictedAttachmentFlag": false,
"viewWorkerPersonalDetailsFlag": false
},
"links": [
{
"rel": "self",
"link": "api/v1/admin/v1/users/012504042014411759438076",
"id": "012504042014411759438076"
},
{
"rel": "buyer-business-units",
"link": "api/v1/admin/v1/users/012504042014411759438076/buyer-business-units"
},
{
"rel": "cost-centers",
"link": "api/v1/admin/v1/users/012504042014411759438076/cost-centers"
},
{
"rel": "delegates",
"link": "api/v1/admin/v1/users/012504042014411759438076/delegates"
},
{
"rel": "labor-types",
"link": "api/v1/admin/v1/users/012504042014411759438076/labor-types"
},
{
"rel": "proxies",
"link": "api/v1/admin/v1/users/012504042014411759438076/proxies"
},
{
"rel": "sites",
"link": "api/v1/admin/v1/users/012504042014411759438076/sites"
}
]
}
}